DescribeDBClusterHealthStatus - 查询集群健康检查状态 - 云原生数据仓库AnalyticDB

调用DescribeDBClusterHealthStatus接口查看数仓版集群的健康状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeDBClusterHealthStatus	get	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	数仓版集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的集群 ID。	am-bp1d8lbdj22rx****
RegionId	string	是	地域 ID。说明您可以调用 DescribeRegions 接口查看可用地域的地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	集群健康状态列表。
CS	object	实例接入节点状态列表。
ActiveCount	long	健康节点个数。	2
UnavailableCount	long	不可用节点个数。	0
RiskCount	long	风险节点个数。	0
ExpectedCount	long	接入节点总个数。	2
Status	string	实例接入节点状态，取值说明： RISK：风险。 NORMAL：健康。 UNAVAILABLE：不可用。	NORMAL
Executor	object	计算节点组健康状态列表。
ActiveCount	long	健康计算节点组个数。	2
UnavailableCount	long	不可用计算节点组个数。	0
RiskCount	long	风险计算节点组个数。	0
ExpectedCount	long	计算节点组总个数。	2
Status	string	计算节点组健康状态，取值说明： RISK：风险。 NORMAL：健康。 UNAVAILABLE：不可用。	NORMAL
Worker	object	存储节点组健康状态列表。
ActiveCount	long	健康存储节点组个数。	2
UnavailableCount	long	不可用存储节点组个数。	0
RiskCount	long	风险存储节点组个数。	0
ExpectedCount	long	存储节点组总个数。	2
Status	string	存储节点组健康状态，取值说明： RISK：风险。 NORMAL：健康。 UNAVAILABLE：不可用。	NORMAL
InstanceStatus	string	集群的健康状态，取值说明： RISK：风险。 NORMAL：健康。 UNAVAILABLE：不可用。说明当集群的实例接入节点状态、计算节点组健康状态和存储节点组健康状态，三个健康状态均为健康且实例探活成功，则集群的健康状态为健康；当三个健康状态中包含风险时，则集群的健康状态为风险；当三个健康状态中包含不可用时，则集群的健康状态为不可用。	NORMAL
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEA

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史