获取集群升级前检查任务详情 - GetPreCheck
功能介绍
获取集群升级前检查任务详情,任务ID由调用集群检查API后从响应体中uid字段获取。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck/tasks/{task_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
| cluster_id | 是 | String | 参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
| task_id | 是 | String | 参数解释: 升级任务ID,调用集群升级API后从响应体中uid字段获取。 约束限制: 不涉及 取值范围: 升级任务ID 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| apiVersion | String | 参数解释: API版本,默认为v3 取值范围: |
| kind | String | 参数解释: 资源类型,默认为PreCheckTask 取值范围: |
| metadata | PrecheckTaskMetadata object | 参数解释: 升级前检查任务元数据信息 取值范围: 不涉及 |
| spec | PrecheckCluserResponseSpec object | 参数解释: 升级前检查任务信息 取值范围: 不涉及 |
| status | PrecheckStatus object | 参数解释: 升级前检查任务状态 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uid | String | 参数解释: 任务ID 取值范围: 不涉及 |
| creationTimestamp | String | 参数解释: 任务创建时间 取值范围: 不涉及 |
| updateTimestamp | String | 参数解释: 任务更新时间 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| clusterID | String | 参数解释: 集群ID 取值范围: 不涉及 |
| clusterVersion | String | 参数解释: 当前集群版本 取值范围: 不涉及 |
| targetVersion | String | 参数解释: 升级目标版本 取值范围: 不涉及 |
| skippedCheckItemList | Array of skippedCheckItemListResponse objects | 参数解释: 跳过检查的项目列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 跳过检查的项目名称 取值范围: 不涉及 |
| resourceSelector | resourceSelectorResponse object | 参数解释: 资源标签选择器,仅节点检查涉及该参数,集群检查和插件检查不涉及 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键值 取值范围: |
| values | Array of strings | 参数解释: 标签值列表 取值范围: 不涉及 |
| operator | String | 参数解释: 标签逻辑运算符 取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 参数解释: 状态 取值范围: |
| expireTimeStamp | String | 参数解释: 检查结果过期时间 取值范围: 不涉及 |
| message | String | 参数解释: 信息,一般是执行错误的日志信息 取值范围: 不涉及 |
| clusterCheckStatus | clusterCheckStatus object | 参数解释: 集群限制检查状态 取值范围: 不涉及 |
| addonCheckStatus | addonCheckStatus object | 参数解释: 插件检查状态 取值范围: 不涉及 |
| nodeCheckStatus | nodeCheckStatus object | 参数解释: 节点检查状态 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 参数解释: 状态 取值范围: |
| itemsStatus | Array of PreCheckItemStatus objects | 参数解释: 检查项状态集合 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 参数解释: 状态 取值范围: |
| itemsStatus | Array of PreCheckItemStatus objects | 参数解释: 检查项状态集合 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 参数解释: 状态 取值范围: |
| nodeStageStatus | Array of NodeStageStatus objects | 参数解释: 节点检查状态 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| nodeInfo | NodeInfo object | 参数解释: 节点信息。 取值范围: 不涉及 |
| itemsStatus | Array of PreCheckItemStatus objects | 参数解释: 检查项状态集合。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uid | String | 参数解释: 节点UID。 取值范围: 不涉及 |
| name | String | 参数解释: 节点名称。 取值范围: 不涉及 |
| status | String | 参数解释: 节点状态 取值范围: 节点资源生命周期管理(如安装卸载等)状态和集群内K8s node状态的综合体现,取值如下 |
| nodeType | String | 参数解释: 节点类型 取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 检查项名称 取值范围: 不涉及 |
| kind | String | 参数解释: 检查项类型 取值范围: |
| group | String | 参数解释: 检查项分组 取值范围: |
| level | String | 参数解释: 检查项风险级别 取值范围: |
| phase | String | 参数解释: 状态 取值范围: |
| message | String | 参数解释: 提示信息 取值范围: 不涉及 |
| riskSource | riskSource object | 参数解释: 风险项来源。 取值范围: 不涉及 |
| errorCodes | Array of strings | 参数解释: 错误码集合 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| configurationRisks | Array of configurationRisks objects | 参数解释: 配置风险项。 取值范围: 不涉及 |
| deprecatedAPIRisks | Array of deprecatedAPIRisks objects | 参数解释: 废弃API风险。 取值范围: 不涉及 |
| nodeRisks | Array of nodeRisks objects | 参数解释: 节点风险。 取值范围: 不涉及 |
| addonRisks | Array of addonRisks objects | 参数解释: 插件风险。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| package | String | 参数解释: 组件名称。 取值范围: 不涉及 |
| sourceFile | String | 参数解释: 涉及文件路径。 取值范围: 不涉及 |
| nodeMsg | String | 参数解释: 节点信息。 取值范围: 不涉及 |
| field | String | 参数解释: 参数值。 取值范围: 不涉及 |
| operation | String | 参数解释: 修改操作类型。 取值范围: 不涉及 |
| originalValue | String | 参数解释: 原始值。 取值范围: 不涉及 |
| value | String | 参数解释: 当前值。 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
表示获取集群升级前检查任务详情成功。
{
"kind" : "PreCheckTask",
"apiVersion" : "v3",
"metadata" : {
"uid" : "f61e008c-1600-41c0-9bde-121de5a30660",
"creationTimestamp" : "2023-11-25 07:20:04.592972 +0000 UTC",
"updateTimestamp" : "2023-11-25 07:21:05.518966 +0000 UTC"
},
"spec" : {
"clusterVersion" : "v1.19.16-r4",
"targetVersion" : "v1.23.5-r0"
},
"status" : {
"phase" : "Success",
"expireTimeStamp" : "2023-11-25 08:21:05.518966 +0000 UTC",
"clusterCheckStatus" : {
"phase" : "Success",
"itemsStatus" : [ {
"name" : "DeprecatedApiCheck",
"kind" : "Risk",
"group" : "LimitCheck",
"level" : "Info",
"phase" : "Success",
"message" : "check item succeed",
"riskSource" : { }
}, {
"name" : "NodeContainerdPodRestartRisk",
"kind" : "Risk",
"group" : "LimitCheck",
"level" : "Warning",
"phase" : "Success",
"message" : "check item succeed",
"riskSource" : { }
}, {
"name" : "ResiduePackageVersion",
"kind" : "Exception",
"group" : "LimitCheck",
"level" : "Fatal",
"phase" : "Success",
"message" : "check item succeed",
"riskSource" : { }
} ]
},
"addonCheckStatus" : {
"phase" : "Success",
"itemsStatus" : [ {
"name" : "AddonLimit",
"kind" : "Exception",
"group" : "AddonCheck",
"level" : "Warning",
"phase" : "Success",
"message" : "check item succeed",
"riskSource" : { }
}, {
"name" : "CoreDNSConfLimit",
"kind" : "Exception",
"group" : "AddonCheck",
"level" : "Fatal",
"phase" : "Success",
"message" : "check item succeed",
"riskSource" : { }
} ]
},
"nodeCheckStatus" : {
"phase" : "Success"
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示获取集群升级前检查任务详情成功。 |
错误码
请参见错误码。