RunClusterCheck - 发起集群检查 - 容器服务 Kubernetes 版 ACK

容器智能运维平台提供丰富的Kubernetes集群检查能力，包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。在正式执行升级、迁移或安装操作前，容器智能运维平台会自动触发检查，仅当检查通过后您才可以执行变更操作。您也可以手动调用RunClusterCheck接口执行集群检查。建议您定期对集群进行检查和维护，预防集群安全风险。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cs:RunClusterCheck

none

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

无

请求语法

POST /clusters/{cluster_id}/checks HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
cluster_id	string	否	集群 ID。	ce0da5a1d627e4e9e9f96cae8ad******

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求体。
type	string	是	检查类型。枚举值： ClusterMigrate : 集群迁移 MasterUpgrade : 集群控制面升级 NodePoolUpgrade : 节点池升级 ClusterUpgrade : 集群升级	NodePoolUpgrade
target	string	否	检查目标。当检查类型参数`type`选择为`NodePoolUpgrade`时，本参数必须设置为节点池 ID。选择其他检查类型时，本参数无需设置。	np1f6779297c4444a3a1cdd29be8******
options	object	否	检查选项。
	string	否	检查参数。当检查类型参数`type`取值为`MasterUpgrade`和`ClusterUpgrade`时，该参数需要设置为`next_version`，具体参数取值为升级的目标集群版本。选择其他检查类型时，本参数无需设置。	next_version:1.32.1-aliyun.1

返回参数

名称	类型	描述	示例值
	object	返回体数据。
request_id	string	请求 ID。	F04DF81D-5C12-1524-B36A-86E025******
check_id	string	检查 ID。	1697100584236****-ce0da5a1d627e4e9e9f96cae8ad****-clustercheck-lboto

示例

正常返回示例

JSON格式

{
  "request_id": "F04DF81D-5C12-1524-B36A-86E025******",
  "check_id": "1697100584236******-ce0da5a1d627e4e9e9f96cae8ad******-clustercheck-lboto"
}

错误码

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

变更历史

更多信息，参考变更详情。