Amazon OpenSearch Service API · Schema
DescribeDomainHealthResponse
AnalyticsAmazon Web ServicesElasticsearchSearch
Properties
| Name | Type | Description |
|---|---|---|
| DomainState | string | The current state of the domain. Processing - The domain has updates in progress. Active - Requested changes have been processed and deployed to the domain. |
| AvailabilityZoneCount | string | The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable. |
| ActiveAvailabilityZoneCount | string | The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable. |
| StandByAvailabilityZoneCount | string | The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable. |
| DataNodeCount | string | The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable. |
| DedicatedMaster | boolean | A boolean that indicates if dedicated master nodes are activated for the domain. |
| MasterEligibleNodeCount | string | The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable |
| WarmNodeCount | string | The number of warm nodes configured for the domain. |
| MasterNode | string | Indicates whether the domain has an elected master node. Available - The domain has an elected master node. UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master no |
| ClusterHealth | string | The current health status of your cluster. Red - At least one primary shard is not allocated to any node. Yellow - All primary shards are allocated to nodes, but some replicas aren’t. Green - All prim |
| TotalShards | string | The total number of primary and replica shards for the domain. |
| TotalUnAssignedShards | string | The total number of primary and replica shards not allocated to any of the nodes for the cluster. |
| EnvironmentInformation | array | A list of EnvironmentInfo for the domain. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-describe-domain-health-response-schema.json",
"title": "DescribeDomainHealthResponse",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/amazon-opensearch-operations-api-openapi.yml#/components/schemas/DescribeDomainHealthResponse",
"type": "object",
"properties": {
"DomainState": {
"type": "string",
"enum": [
"Active",
"Processing",
"NotAvailable"
],
"description": "The current state of the domain. Processing - The domain has updates in progress. Active - Requested changes have been processed and deployed to the domain."
},
"AvailabilityZoneCount": {
"type": "string",
"description": "The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable."
},
"ActiveAvailabilityZoneCount": {
"type": "string",
"description": "The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable."
},
"StandByAvailabilityZoneCount": {
"type": "string",
"description": "The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable."
},
"DataNodeCount": {
"type": "string",
"description": "The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable."
},
"DedicatedMaster": {
"type": "boolean",
"description": "A boolean that indicates if dedicated master nodes are activated for the domain."
},
"MasterEligibleNodeCount": {
"type": "string",
"description": "The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable."
},
"WarmNodeCount": {
"type": "string",
"description": "The number of warm nodes configured for the domain."
},
"MasterNode": {
"type": "string",
"enum": [
"Available",
"UnAvailable"
],
"description": "Indicates whether the domain has an elected master node. Available - The domain has an elected master node. UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached."
},
"ClusterHealth": {
"type": "string",
"enum": [
"Red",
"Yellow",
"Green",
"NotAvailable"
],
"description": "The current health status of your cluster. Red - At least one primary shard is not allocated to any node. Yellow - All primary shards are allocated to nodes, but some replicas aren’t. Green - All primary shards and their replicas are allocated to nodes. NotAvailable - Unable to retrieve cluster health."
},
"TotalShards": {
"type": "string",
"description": "The total number of primary and replica shards for the domain."
},
"TotalUnAssignedShards": {
"type": "string",
"description": "The total number of primary and replica shards not allocated to any of the nodes for the cluster."
},
"EnvironmentInformation": {
"type": "array",
"items": {
"$ref": "#/$defs/EnvironmentInfo"
},
"description": "A list of EnvironmentInfo for the domain."
}
},
"$defs": {
"AvailabilityZoneInfo": {
"type": "object",
"properties": {
"AvailabilityZoneName": {
"type": "string",
"description": "The name of the Availability Zone."
},
"ZoneStatus": {
"type": "string",
"enum": [
"Active",
"StandBy",
"NotAvailable"
],
"description": "The current state of the Availability Zone. Current options are Active and StandBy. Active - Data nodes in the Availability Zone are in use. StandBy - Data nodes in the Availability Zone are in a standby state. NotAvailable - Unable to retrieve information."
},
"ConfiguredDataNodeCount": {
"type": "string",
"description": "The total number of data nodes configured in the Availability Zone."
},
"AvailableDataNodeCount": {
"type": "string",
"description": "The number of data nodes active in the Availability Zone."
},
"TotalShards": {
"type": "string",
"description": "The total number of primary and replica shards in the Availability Zone."
},
"TotalUnAssignedShards": {
"type": "string",
"description": "The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone."
}
}
},
"EnvironmentInfo": {
"type": "object",
"properties": {
"AvailabilityZoneInformation": {
"type": "array",
"items": {
"$ref": "#/$defs/AvailabilityZoneInfo"
},
"description": "A list of AvailabilityZoneInfo for the domain."
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-describe-domain-health-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.