Query cluster health status using DescribeDBClusterHealthStatus - AnalyticDB - Alibaba Cloud - AnalyticDB

View a cluster's health status.

Operation description

For the service access address, see service endpoint.

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	The ID of the Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of clusters.	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 elements

Element	Type	Description	Example
	object
CS	object	The health status of the instance access nodes.
ActiveCount	integer	The number of healthy instance access nodes.	0
UnavailableCount	integer	The number of unavailable instance access nodes.	1
RiskCount	integer	The number of instance access nodes at risk.	0
ExpectedCount	integer	The total number of instance access nodes.	1
Status	string	The health status of the instance access nodes. Valid values: RISK: The instance access nodes are at risk. NORMAL: The instance access nodes are healthy. UNAVAILABLE: The instance access nodes are unavailable.	UNAVAILABLE
Executor	object	The health status of the executor groups.
ActiveCount	integer	The number of healthy executor nodes.	0
UnavailableCount	integer	The number of unavailable executor nodes.	1
RiskCount	integer	The number of executor nodes at risk.	0
ExpectedCount	integer	The total number of executor nodes.	1
Status	string	The health status of the executor groups. Valid values: RISK: The executor groups are at risk. NORMAL: The executor groups are healthy. UNAVAILABLE: The executor groups are unavailable.	UNAVAILABLE
Worker	object	The health status of the worker node groups.
ActiveCount	integer	The number of healthy worker node groups.	0
UnavailableCount	integer	The number of unavailable worker node groups.	1
RiskCount	integer	The number of worker node groups at risk.	1
ExpectedCount	integer	The total number of worker node groups.	1
Status	string	The health status of the worker node groups. Valid values: RISK: The worker node groups are at risk. NORMAL: The worker node groups are healthy. UNAVAILABLE: The worker node groups are unavailable.	UNAVAILABLE
InstanceStatus	string	The health status of the cluster. Valid values: RISK: The cluster is at risk. NORMAL: The cluster is healthy. UNAVAILABLE: The cluster is unavailable. Note The cluster health status is considered NORMAL only if the instance access nodes, executor groups, and worker node groups are all NORMAL, and the instance is responsive. If any of these components has a RISK status, the cluster status is RISK. If any component has an UNAVAILABLE status, the cluster status is UNAVAILABLE.	NORMAL
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CAV
AccessDeniedDetail	string	Details of the authentication failure.	Authentication failed.

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": "Authentication failed."
}

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.