Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

get/2021-01-01/opensearch/domain/{DomainName}/health

Path parameters

DomainNamestring required

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

The name of the domain.

Response

Success

DomainState'Active' | 'Processing' | 'NotAvailable'
<p>The current state of the domain.</p> <ul> <li> <p> <code>Processing</code> - The domain has updates in progress.</p> </li> <li> <p> <code>Active</code> - Requested changes have been processed and deployed to the domain.</p> </li> </ul>
AvailabilityZoneCountstring

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.

ActiveAvailabilityZoneCountstring

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.

StandByAvailabilityZoneCountstring

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.

DataNodeCountstring

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.

DedicatedMasterboolean

A boolean that indicates if dedicated master nodes are activated for the domain.

MasterEligibleNodeCountstring

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 <code>NotAvailable</code>.

WarmNodeCountstring

The number of warm nodes configured for the domain.

MasterNode'Available' | 'UnAvailable'
<p>Indicates whether the domain has an elected master node.</p> <ul> <li> <p> <b>Available</b> - The domain has an elected master node.</p> </li> <li> <p> <b>UnAvailable</b> - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.</p> </li> </ul>
ClusterHealth'Red' | 'Yellow' | 'Green' | 'NotAvailable'
<p>The current health status of your cluster.</p> <ul> <li> <p> <code>Red</code> - At least one primary shard is not allocated to any node.</p> </li> <li> <p> <code>Yellow</code> - All primary shards are allocated to nodes, but some replicas aren’t.</p> </li> <li> <p> <code>Green</code> - All primary shards and their replicas are allocated to nodes.</p> </li> <li> <p> <code>NotAvailable</code> - Unable to retrieve cluster health.</p> </li> </ul>
TotalShardsstring

The total number of primary and replica shards for the domain.

TotalUnAssignedShardsstring

The total number of primary and replica shards not allocated to any of the nodes for the cluster.