DescribeHealthStatus - AnalyticDB

Queries the health status of an AnalyticDB for PostgreSQL instance and its nodes.

Operation description

This operation is called to query the health status of an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode and its coordinator and compute nodes.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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
gpdb:DescribeHealthStatus	get	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.	gp-bp12ga6v69h86****
Key	string	Yes	The performance metric that you want to query. Separate multiple values with commas (,). For more information, see Performance parameters.	node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status

Response parameters

Parameter	Type	Description	Example
	object
Status	object	The queried performance metrics. Each performance metric consists of the parameter name, status, and metric value. The metric information is returned only for the performance parameters specified by Key. For example, if you set Key to adbpg_status, only the metric information of adbpg_status is returned. For more information about performance parameters, see Performance parameters.
adbpg_status	object	The information of instance health status.
Status	string	The health status of the instance. Valid values: critical: The coordinator node or a compute node is unavailable. In this case, this metric is marked in red in the console. healthy: All nodes are available. In this case, this metric is marked in green in the console.	healthy
Value	float	The metric value of instance health status. Valid values: 1: healthy 0: critical	1
adbpg_connection_status	object	The information of instance connection health status.
Status	string	The connection health status of the instance. Valid values: critical: The instance connection usage is greater than 95%. In this case, this metric is marked in red in the console. warning: The instance connection usage is greater than 90% and less than or equal to 95%. In this case, this metric is marked in yellow in the console. healthy: The instance connection usage is less than or equal to 90%. In this case, this metric is marked in green in the console. Note The instance connection usage is the maximum connection usage among all the coordinator and compute nodes.	healthy
Value	float	The metric value of instance connection usage. Unit: %.	1.71
adbpg_disk_status	object	The information of instance storage status. Note This parameter value is returned only for instances in elastic storage mode.
Status	string	The storage status of the instance. Valid values: critical: The instance storage usage is greater than or equal to 90%. In this case, this metric is marked in red in the console and the instance is locked. warning: The instance storage usage is greater than or equal to 70% and less than 90%. In this case, this metric is marked in yellow in the console. healthy: The instance storage usage is less than 70%. In this case, this metric is marked in green in the console. Note The instance storage usage is the average storage usage of all compute nodes.	healthy
Value	float	The metric value of instance storage usage. Unit: %.	1.52
adbpg_disk_usage_percent	object	The information of instance storage usage. Note This parameter value is returned only for instances in elastic storage mode.
Status	string	The status corresponding to the storage usage of the instance. Valid values: critical: The instance storage usage is greater than or equal to 90%. In this case, the instance is locked. warning: The instance storage usage is greater than or equal to 70% and less than 90%. healthy: The instance storage usage is less than 70%. Note The instance storage usage is the average storage usage of all compute nodes.	healthy
Value	float	The metric value of instance storage usage. Unit: %.	1.52
adbpg_master_disk_usage_percent_max	object	The information of maximum coordinator node storage usage. Note This parameter value is returned only for instances in elastic storage mode.
Status	string	The status corresponding to the maximum storage usage of the coordinator node. Valid values: critical: The coordinator node storage usage is greater than or equal to 90%. In this case, the instance is locked. warning: The coordinator node storage usage is greater than or equal to 70% and less than 90%. healthy: The coordinator node storage usage is less than 70%.	healthy
Value	float	The metric value of maximum coordinator node storage usage. Unit: %.	1.34
adbgp_segment_disk_usage_percent_max	object	The information of maximum compute node storage usage. Note This parameter value is returned only for instances in elastic storage mode.
Status	string	The status corresponding to the maximum storage usage among all compute nodes. Valid values: critical: The compute node storage usage is greater than or equal to 90%. In this case, the instance is locked. warning: The compute node storage usage is greater than or equal to 80% and less than 90%. healthy: The compute node storage usage is less than 80%.	healthy
Value	float	The metric value of maximum compute node storage usage. Unit: %.	1.52
node_master_status	object	The information of coordinator node health status.
Status	string	The health status of the coordinator node. Valid values: critical: The primary or standby coordinator node is unavailable. In this case, this metric is marked in red in the console. healthy: Both the primary and standby coordinator nodes are available. In this case, this metric is marked in green in the console.	healthy
Value	float	The metric value of coordinator node health status. Valid values: 1: healthy 0: critical	1
node_segment_disk_status	object	The information of compute node storage status. Note This parameter value is returned only for instances in elastic storage mode.
Status	string	The storage status of compute nodes. Valid values: critical: The compute node storage usage is greater than or equal to 90%. In this case, this metric is marked in red in the console and the instance is locked. warning: The compute node storage usage is greater than or equal to 80% and less than 90%. In this case, this metric is marked in yellow in the console. healthy: The compute node storage usage is less than 80%. In this case, this metric is marked in green in the console. Note The compute node storage usage is the maximum storage usage among all compute nodes.	healthy
Value	float	The metric value of maximum compute node storage usage. Unit: %.	1.52
node_master_connection_status	object	The information of coordinator node connection health status.
Status	string	The connection health status of the coordinator node. Valid values: critical: The coordinator node connection usage is greater than 95%. In this case, this metric is marked in red in the console. warning: The coordinator node connection usage is greater than or equal to 90% and less than 95%. In this case, this metric is marked in yellow in the console. healthy: The coordinator node connection usage is less than 90%. In this case, this metric is marked in green in the console. Note The coordinator node connection usage is the maximum connection usage of the coordinator node.	healthy
Value	float	The metric value of coordinator node connection usage. Unit: %.	1.71
node_segment_connection_status	object	The information of compute node connection health status.
Status	string	The connection health status of compute nodes. Valid values: critical: The compute node connection usage is greater than or equal to 95%. In this case, this metric is marked in red in the console. warning: The compute node connection usage is greater than or equal to 90% and less than 95%. In this case, this metric is marked in yellow in the console. healthy: The compute node connection usage is less than 90%. In this case, this metric is marked in green in the console. Note The compute node connection usage is the maximum connection usage among all compute nodes.	healthy
Value	float	The metric value of maximum compute node connection usage. Unit: %.	0.48
adbpg_master_status	object	The information of coordinator node availability status.
Status	string	The availability status of the coordinator node. Valid values: critical: Both the primary and standby coordinator nodes are unavailable. In this case, this metric is marked in red in the console. warning: The primary or standby coordinator node is unavailable. In this case, this metric is marked in yellow in the console. healthy: Both the primary and standby coordinator nodes are available. In this case, this metric is marked in green in the console.	healthy
Value	float	The metric value of coordinator node availability status. Valid values:	1
adbpg_segment_status	object	The information of compute node availability status.
Status	string	The availability status of compute nodes. Valid values: critical: All the primary and secondary compute nodes are unavailable. In this case, this metric is marked in red in the console. warning: Fifty percent or more than fifty percent of compute nodes are unavailable. In this case, this metric is marked in yellow in the console. healthy: All compute nodes are available. In this case, this metric is marked in green in the console.	healthy
Value	float	The metric value of compute node availability status.	1
adbpg_instance_total_data_gb	object	The total amount of data storage of the instance.
Value	float	The total amount of data storage of the instance. Unit: GB.	4.1
adbpg_instance_hot_data_gb	object	The total amount of hot data storage.
Value	float	The total amount of hot data storage. Unit: GB.	4.1
adbpg_instance_cold_data_gb	object	The total amount of cold data storage.
Value	float	The total amount of cold data storage. Unit: GB.	0
RequestId	string	The ID of the request.	D97B4191-104D-10CE-8BC5-53**********
DBClusterId	string	The ID of instance.	gp-bp12ga6v69h86****

Examples

Sample success responses

JSONformat

{
  "Status": {
    "adbpg_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "adbpg_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_disk_usage_percent": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_master_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.34
    },
    "adbgp_segment_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "node_segment_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "node_segment_connection_status": {
      "Status": "healthy",
      "Value": 0.48
    },
    "adbpg_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_segment_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_instance_total_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_hot_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_cold_data_gb": {
      "Value": 0
    }
  },
  "RequestId": "D97B4191-104D-10CE-8BC5-53**********",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-06-30	The response structure of the API has changed	View Change Details