OpenSearchService / Client / describe_domain_health

describe_domain_health#

OpenSearchService.Client.describe_domain_health(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_domain_health(
    DomainName='string'
)
Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain.

Return type:

dict

Returns:

Response Syntax

{
    'DomainState': 'Active'|'Processing'|'NotAvailable',
    'AvailabilityZoneCount': 'string',
    'ActiveAvailabilityZoneCount': 'string',
    'StandByAvailabilityZoneCount': 'string',
    'DataNodeCount': 'string',
    'DedicatedMaster': True|False,
    'MasterEligibleNodeCount': 'string',
    'WarmNodeCount': 'string',
    'MasterNode': 'Available'|'UnAvailable',
    'ClusterHealth': 'Red'|'Yellow'|'Green'|'NotAvailable',
    'TotalShards': 'string',
    'TotalUnAssignedShards': 'string',
    'EnvironmentInformation': [
        {
            'AvailabilityZoneInformation': [
                {
                    'AvailabilityZoneName': 'string',
                    'ZoneStatus': 'Active'|'StandBy'|'NotAvailable',
                    'ConfiguredDataNodeCount': 'string',
                    'AvailableDataNodeCount': 'string',
                    'TotalShards': 'string',
                    'TotalUnAssignedShards': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    The result of a DescribeDomainHealth request. Contains health information for the requested domain.

    • 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 to fetch this information, it will return NotAvailable.

    • 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 node hasn’t been reached.

    • 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 primary shards and their replicas are allocated to nodes.

      • NotAvailable - Unable to retrieve cluster health.

    • 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 (list) –

      A list of EnvironmentInfo for the domain.

      • (dict) –

        Information about the active domain environment.

        • AvailabilityZoneInformation (list) –

          A list of AvailabilityZoneInfo for the domain.

          • (dict) –

            Information about an Availability Zone on a domain.

            • AvailabilityZoneName (string) –

              The name of the Availability Zone.

            • ZoneStatus (string) –

              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 (string) –

              The total number of data nodes configured in the Availability Zone.

            • AvailableDataNodeCount (string) –

              The number of data nodes active in the Availability Zone.

            • TotalShards (string) –

              The total number of primary and replica shards in the Availability Zone.

            • TotalUnAssignedShards (string) –

              The total number of primary and replica shards that aren’t allocated to any of the nodes in the Availability Zone.

Exceptions