容器智能运维平台提供丰富的Kubernetes集群检查能力,包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。在正式执行升级、迁移或安装操作前,容器智能运维平台会自动触发检查,仅当检查通过后您才可以执行变更操作。您也可以手动调用RunClusterCheck接口执行集群检查。建议您定期对集群进行检查和维护,预防集群安全风险。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cs:RunClusterCheck | none |
|
| 无 |
请求语法
POST /clusters/{cluster_id}/checks HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
cluster_id | string | 否 | 集群 ID。 | ce0da5a1d627e4e9e9f96cae8ad07**** |
body | object | 否 | 请求体。 | |
type | string | 是 | 检查类型。 | NodePoolUpgrade |
target | string | 否 | 检查目标。 | np1f6779297c4444a3a1cdd29be8e5**** |
options | object | 否 | 检查选项。 | |
string | 否 | 检查参数。 | next_version |
返回参数
示例
正常返回示例
JSON
格式
{
"request_id": "F04DF81D-5C12-1524-B36A-86E02526****",
"check_id": "1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-14 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-11-21 | API 内部配置变更,不影响调用 | 查看变更详情 |