Query cluster health status using DescribeDBClusterHealthStatus - AnalyticDB

Views the health status of a cluster.

Operation description

For more information about service endpoints, see service endpoints.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeDBClusterHealthStatus

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID of the cluster. Applies to Enterprise Edition, Basic Edition, or Data Lakehouse Edition clusters. Note Call the DescribeDBClusters operation to view cluster IDs.	amv-uf6o6m8p6x7v****
RegionId	string	Yes	ID of the region. Note Call the DescribeRegions operation to view region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
CS	object	List of instance access node statuses.
ActiveCount	integer	Number of healthy nodes.	0
UnavailableCount	integer	Number of unavailable nodes.	1
RiskCount	integer	Number of nodes at risk.	0
ExpectedCount	integer	Total number of access nodes.	1
Status	string	Status of the instance access node. Valid values: RISK: At risk. NORMAL: Healthy. UNAVAILABLE: Unavailable.	UNAVAILABLE
Executor	object	List of compute node group health statuses.
ActiveCount	integer	Number of healthy nodes.	0
UnavailableCount	integer	Number of unavailable nodes.	1
RiskCount	integer	Number of nodes at risk.	0
ExpectedCount	integer	Total number of compute nodes.	1
Status	string	Health status of the compute node group. Valid values: RISK: At risk. NORMAL: Healthy. UNAVAILABLE: Unavailable.	UNAVAILABLE
Worker	object	List of storage node health statuses.
ActiveCount	integer	Number of healthy storage node groups.	0
UnavailableCount	integer	Number of unavailable storage node groups.	1
RiskCount	integer	Number of storage node groups at risk.	1
ExpectedCount	integer	Total number of storage node groups.	1
Status	string	Health status of the storage node group. Valid values: RISK: At risk. NORMAL: Healthy. UNAVAILABLE: Unavailable.	UNAVAILABLE
InstanceStatus	string	Health status of the cluster. Valid values: RISK: At risk. NORMAL: Healthy. UNAVAILABLE: Unavailable. Note The cluster health status is NORMAL only if all three component statuses — instance access node status, compute node group status, and storage node group status — are NORMAL, and the instance liveness check succeeds. The cluster health status is RISK if any component status is RISK. The cluster health status is UNAVAILABLE if any component status is UNAVAILABLE.	NORMAL
RequestId	string	ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CAV
AccessDeniedDetail	string

Examples

Success response

JSON format

{
  "CS": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 0,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "Executor": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 0,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "Worker": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 1,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "InstanceStatus": "NORMAL",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CAV",
  "AccessDeniedDetail": ""
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.