文档

ListClusterChecks - 查询所有集群检查的列表

更新时间:

容器智能运维平台提供丰富的Kubernetes集群检查能力,包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。您可以调用ListClusterChecks接口,根据集群ID查询集群检查的列表和检查相关信息,例如检查类型、状态、创建和完成时间等。

调试

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

授权信息

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

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

请求语法

GET /clusters/{cluster_id}/checks

请求参数

名称类型必填描述示例值
cluster_idstring

集群 ID。

ce0da5a1d627e4e9e9f96cae8ad07****
typestring

检查类型。

ClusterUpgrade
targetstring

筛选指定的检查对象。

返回参数

名称类型描述示例值
object

Schema of Response

checksobject []

检查列表。

check_idstring

检查 ID。

1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto
typestring

检查类型。

ClusterUpgrade
statusstring

检查状态。

Succeeded
messagestring

检查状态信息。

task succeed
created_atstring

创建时间。

2023-10-16T08:31:20.292030178Z
finished_atstring

完成时间。

2023-10-16T08:35:20.292030178Z

示例

正常返回示例

JSON格式

{
  "checks": [
    {
      "check_id": "1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto",
      "type": "ClusterUpgrade",
      "status": "Succeeded",
      "message": "task succeed",
      "created_at": "2023-10-16T08:31:20.292030178Z",
      "finished_at": "2023-10-16T08:35:20.292030178Z"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-14OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:target
2023-11-21API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)