全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Nov 07, 2024

    查看集群的健康状态。

    接口说明

    当前服务的接入地址请参见服务接入点。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    湖仓版集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看集群 ID。
    		amv-uf6o6m8p6x7v****
    RegionIdstring是

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看集群的地域 ID。
    		cn-hangzhou

    返回参数

    名称类型描述示例值
    object
    CSobject

    实例接入节点状态的列表。

    ActiveCountlong

    健康节点个数。

    		0
    UnavailableCountlong

    不可用节点个数。

    		1
    RiskCountlong

    风险节点个数。

    		0
    ExpectedCountlong

    接入节点总个数。

    		1
    Statusstring

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

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

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

    ActiveCountlong

    健康节点个数。

    		0
    UnavailableCountlong

    不可用节点个数。

    		1
    RiskCountlong

    风险节点个数。

    		0
    ExpectedCountlong

    计算节点总个数。

    		1
    Statusstring

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

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

    存储节点健康状态列表。

    ActiveCountlong

    健康存储节点组个数。

    		0
    UnavailableCountlong

    不可用存储节点组个数。

    		1
    RiskCountlong

    风险存储节点组个数。

    		1
    ExpectedCountlong

    存储节点组总个数。

    		1
    Statusstring

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

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

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

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

    请求 ID。

    		1AD222E9-E606-4A42-BF6D-8A4442913CAV

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2024-05-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情