DescribeDBClusterHealthStatus - Query cluster health status | AnalyticDB for MySQL - AnalyticDB

Queries the health status of an AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

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

get

*DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Note Call DescribeDBClusters to obtain cluster IDs of AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in a region.	am-bp1d8lbdj22rx****
RegionId	string	Yes	The ID of the region. Note Call DescribeRegions to query available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
CS	object	Health status of access nodes.
ActiveCount	integer	The number of healthy access nodes.	2
UnavailableCount	integer	The number of unavailable access nodes.	0
RiskCount	integer	The number of risky access nodes.	0
ExpectedCount	integer	The total number of access nodes.	2
Status	string	The health state of access nodes. Valid values: RISK: risky NORMAL: healthy UNAVAILABLE: unavailable	NORMAL
Executor	object	Health status of compute node groups.
ActiveCount	integer	The number of healthy compute node groups.	2
UnavailableCount	integer	The number of unavailable compute node groups.	0
RiskCount	integer	The number of risky compute node groups.	0
ExpectedCount	integer	The total number of compute node groups.	2
Status	string	The health state of compute node groups. Valid values: RISK: risky NORMAL: healthy UNAVAILABLE: unavailable	NORMAL
Worker	object	Health status of storage node groups.
ActiveCount	integer	The number of healthy storage node groups.	2
UnavailableCount	integer	The number of unavailable storage node groups.	0
RiskCount	integer	The number of risky storage node groups.	0
ExpectedCount	integer	The total number of storage node groups.	2
Status	string	The health state of storage node groups. Valid values: RISK: risky NORMAL: healthy UNAVAILABLE: unavailable	NORMAL
InstanceStatus	string	The health state of the cluster. Valid values: RISK: risky NORMAL: healthy UNAVAILABLE: unavailable Note The cluster health state is healthy when all three components (access nodes, compute node groups, and storage node groups) are healthy and the cluster is alive. If any component is risky, the cluster state is risky. If any component is unavailable, the cluster state is unavailable.	NORMAL
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEA

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId does not exist. Verify that the value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.