DescribeDBClusterHealthStatus - AnalyticDB - Alibaba Cloud Documentation Center

Queries the health status of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeDBClusterHealthStatus	list	DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.	amv-uf6o6m8p6x7v****
RegionId	string	Yes	The region ID of the cluster. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
CS	object	The access nodes of the queried cluster.
ActiveCount	long	The number of healthy access nodes.	2
UnavailableCount	long	The number of unavailable access nodes.	0
RiskCount	long	The number of risky nodes.	0
ExpectedCount	long	The total number of access nodes.	2
Status	string	The health state of access nodes. Valid values: RISK NORMAL UNAVAILABLE	NORMAL
Executor	object	The compute node groups of the queried cluster.
ActiveCount	long	The number of healthy access nodes.	2
UnavailableCount	long	The number of unavailable access nodes.	0
RiskCount	long	The number of risky nodes.	0
ExpectedCount	long	The total number of compute nodes.	2
Status	string	The health state of compute node groups. Valid values: RISK NORMAL UNAVAILABLE	NORMAL
Worker	object	The storage node groups of the queried cluster.
ActiveCount	long	The number of healthy storage node groups.	2
UnavailableCount	long	The number of unavailable storage node groups.	0
RiskCount	long	The number of risky storage node groups.	0
ExpectedCount	long	The total number of storage node groups.	2
Status	string	The health state of storage node groups. Valid values: RISK NORMAL UNAVAILABLE	NORMAL
InstanceStatus	string	The health state of the cluster. Valid values: RISK NORMAL UNAVAILABLE Note When the states of the access nodes, compute node groups, and storage node groups of a cluster are all NORMAL and a connection to the cluster is established, the state of the cluster is NORMAL. When the state of the access nodes, compute node groups, or storage node groups of the cluster is RISK, the state of the cluster is RISK. When the state of the access nodes, compute node groups, or storage node groups of the cluster is UNAVAILABLE, the state of the cluster is UNAVAILABLE.	NORMAL
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEA

Examples

Sample success responses

JSONformat

{
  "CS": {
    "ActiveCount": 2,
    "UnavailableCount": 0,
    "RiskCount": 0,
    "ExpectedCount": 2,
    "Status": "NORMAL"
  },
  "Executor": {
    "ActiveCount": 2,
    "UnavailableCount": 0,
    "RiskCount": 0,
    "ExpectedCount": 2,
    "Status": "NORMAL"
  },
  "Worker": {
    "ActiveCount": 2,
    "UnavailableCount": 0,
    "RiskCount": 0,
    "ExpectedCount": 2,
    "Status": "NORMAL"
  },
  "InstanceStatus": "NORMAL",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEA",
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-14	The Error code has changed. The response structure of the API has changed	View Change Details