All Products
Search
Document Center

AnalyticDB:DescribeDBClusterHealthStatus

Last Updated:Aug 30, 2024

Queries the health status of an AnalyticDB for MySQL Data Warehouse Edition cluster.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeDBClusterHealthStatusget
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.
am-bp1d8lbdj22rx****
RegionIdstringYes

The ID of the region.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
CSobject

Health state details of access nodes.

ActiveCountlong

The number of healthy access nodes.

2
UnavailableCountlong

The number of unavailable access nodes.

0
RiskCountlong

The number of risky access nodes.

0
ExpectedCountlong

The total number of access nodes.

2
Statusstring

The health state of access nodes. Valid values:

  • RISK: risky
  • NORMAL: healthy
  • UNAVAILABLE: unavailable
NORMAL
Executorobject

Health state details of compute node groups.

ActiveCountlong

The number of healthy compute node groups.

2
UnavailableCountlong

The number of unavailable compute node groups.

0
RiskCountlong

The number of risky compute node groups.

0
ExpectedCountlong

The total number of compute node groups.

2
Statusstring

The health state of compute node groups. Valid values:

  • RISK: risky
  • NORMAL: healthy
  • UNAVAILABLE: unavailable
NORMAL
Workerobject

Health state details of storage node groups.

ActiveCountlong

The number of healthy storage node groups.

2
UnavailableCountlong

The number of unavailable storage node groups.

0
RiskCountlong

The number of risky storage node groups.

0
ExpectedCountlong

The total number of storage node groups.

2
Statusstring

The health state of storage node groups. Valid values:

  • RISK: risky
  • NORMAL: healthy
  • UNAVAILABLE: unavailable
NORMAL
InstanceStatusstring

The health state of the cluster. Valid values:

  • RISK: risky

  • NORMAL: healthy

  • UNAVAILABLE: unavailable

Note If the health states of access nodes, compute node groups, and storage node groups are all healthy and the cluster is detected to be alive, the health state of the cluster is healthy. If the preceding three health states include risky, the health state of the cluster is risky. If the preceding three health states include unavailable, the health state of the cluster is unavailable.
NORMAL
RequestIdstring

The ID of the request.

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"
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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.