调用DescribeDBClusterHealthStatus接口查看AnalyticDB MySQL数仓版（3.0）集群的健康状态。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBClusterHealthStatus

系统规定参数。取值：DescribeDBClusterHealthStatus。

DBClusterId String 是 am-bp1d8lbdj22rx****

AnalyticDB MySQL数仓版（3.0）集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL数仓版（3.0）集群的集群ID。
RegionId String 是 cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看可用地域的地域ID。

返回数据

名称 类型 示例值 描述
CS Object

实例接入节点状态列表。
ActiveCount Long 2

健康节点个数。
UnavailableCount Long 0

不可用节点个数。
RiskCount Long 0

风险节点个数。
ExpectedCount Long 2

接入节点总个数。
Status String NORMAL

实例接入节点状态，取值说明：

  • RISK：风险。
  • NORMAL：健康。
  • UNAVAILABLE：不可用。
Executor Object

计算节点组健康状态列表。
ActiveCount Long 2

健康计算节点组个数。
UnavailableCount Long 0

不可用计算节点组个数。
RiskCount Long 0

风险计算节点组个数。
ExpectedCount Long 2

计算节点组总个数。
Status String NORMAL

计算节点组健康状态，取值说明：

  • RISK：风险。
  • NORMAL：健康。
  • UNAVAILABLE：不可用。
Worker Object

存储节点组健康状态列表。
ActiveCount Long 2

健康存储节点组个数。
UnavailableCount Long 0

不可用存储节点组个数。
RiskCount Long 0

风险存储节点组个数。
ExpectedCount Long 2

存储节点组总个数。
Status String NORMAL

存储节点组健康状态，取值说明：

  • RISK：风险。
  • NORMAL：健康。
  • UNAVAILABLE：不可用。
InstanceStatus String NORMAL

集群的健康状态，取值说明：

  • RISK：风险。
  • NORMAL：健康。
  • UNAVAILABLE：不可用。
    说明 当集群的实例接入节点状态、计算节点组健康状态和存储节点组健康状态，三个健康状态均为健康且实例探活成功，则集群的健康状态为健康；当三个健康状态中包含风险时，则集群的健康状态为风险；当三个健康状态中包含不可用时，则集群的健康状态为不可用。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEA

请求ID。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterHealthStatus
&DBClusterId=am-bp1d8lbdj22rx****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterHealthStatusResponse>
    <CS>
        <ActiveCount>2</ActiveCount>
        <UnavailableCount>0</UnavailableCount>
        <RiskCount>0</RiskCount>
        <ExpectedCount>2</ExpectedCount>
        <Status>NORMAL</Status>
    </CS>
    <Executor>
        <ActiveCount>2</ActiveCount>
        <UnavailableCount>0</UnavailableCount>
        <RiskCount>0</RiskCount>
        <ExpectedCount>2</ExpectedCount>
        <Status>NORMAL</Status>
    </Executor>
    <Worker>
        <ActiveCount>2</ActiveCount>
        <UnavailableCount>0</UnavailableCount>
        <RiskCount>0</RiskCount>
        <ExpectedCount>2</ExpectedCount>
        <Status>NORMAL</Status>
    </Worker>
    <InstanceStatus>NORMAL</InstanceStatus>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEA</RequestId>
</DescribeDBClusterHealthStatusResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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"
}

错误码

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

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