开启集群升级流程引导任务
功能介绍
该API用于创建一个集群升级流程引导任务。请在调用本接口完成引导任务创建之后,通过集群升级前检查开始检查任务。
升级流程任务用于控制集群升级任务的执行流程,执行流程为 升级前检查 => 集群升级 => 升级后检查。
调用方法
请参见如何调用API。
URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
| cluster_id | 是 | String | 参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。 约束限制: GET方法不做校验 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| kind | 是 | String | 参数解释: API类型 约束限制: 固定值 取值范围: |
| apiVersion | 是 | String | 参数解释: API版本 约束限制: 固定值 取值范围: |
| spec | 是 | WorkFlowSpec object | 参数解释: 集合类的元素类型,您对集群升级流程主体都在spec中给出。CCE通过spec的描述来创建或更新对象。 约束限制: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| kind | String | API类型,固定值“WorkFlowTask”,该值不可修改。 |
| apiVersion | String | API版本,固定值“v3”,该值不可修改。 |
| metadata | Metadata object | 升级流程的元数据信息 |
| spec | WorkFlowResponseSpec object | 集合类的元素类型,您对集群升级流程主体都在spec中给出。CCE通过spec的描述来创建或更新对象。 |
| status | WorkFlowStatus object | 集合类的元素类型,用于记录本次集群升级流程的当前状态信息,包含了集群升级流程的各个流程的执行状态 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uid | String | 参数解释: 唯一id标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| name | String | 参数解释: 资源名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| labels | Map<String,String> | 参数解释: 资源标签,key/value对格式,接口保留字段,填写不会生效 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| annotations | Map<String,String> | 参数解释: 资源注解,由key/value组成 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| updateTimestamp | String | 参数解释: 更新时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| creationTimestamp | String | 参数解释: 创建时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| clusterID | String | 集群ID |
| clusterVersion | String | 当前集群版本 |
| targetVersion | String | 本次集群升级的目标版本 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 集群升级流程的执行状态: Init: 表示该升级流程中还未有任何任务开始运行 Running: 表示该升级流程中已有任务开始执行 Pending: 表示该升级流程中有任务执行失败 Success: 表示该升级流程中所有任务都已执行成功 Cancel: 表示该升级流程已被取消 |
| pointStatuses | Array of PointStatus objects | 升级流程中的各个任务项的执行状态 |
| lineStatuses | Array of LineStatus objects | 表示该升级流程的任务执行线路 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| taskType | String | 集群升级任务类型: Cluster: 集群升级任务 PreCheck: 集群升级预检查任务 Rollback: 集群升级回归任务 Snapshot: 集群升级快照任务 PostCheck: 集群升级后检查任务 |
| taskID | String | 升级任务项ID |
| status | String | 集群升级状态: Init: 任务初始状态 Queuing: 任务已进入执行队列 Running: 任务开始执行 Success: 任务执行成功 Failed: 任务执行失败 |
| startTimeStamp | String | 升级任务开始时间 |
| endTimeStamp | String | 升级任务结束时间 |
| expireTimeStamp | String | 升级任务过期时间(当前仅升级前检查任务适用) |
请求示例
开启升级集群至v1.23版本的流程
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows
{
"kind" : "WorkFlowTask",
"apiVersion" : "v3",
"spec" : {
"targetVersion" : "v1.23",
"clusterID" : "b4b9e60f-8aa2-11ee-af09-0255ac10004f"
}
} 响应示例
状态码:201
表示在指定集群下创建升级流程成功。
{
"kind" : "WorkFlowTask",
"apiVersion" : "v3",
"metadata" : {
"uid" : "5ddfddfe-87db-11ec-b5e5-0255ac111914"
},
"spec" : {
"clusterID" : "b4b9e60f-8aa2-11ee-af09-0255ac10004f",
"clusterVersion" : "v1.17.17-r0",
"targetVersion" : "v1.19.16-r80"
},
"status" : {
"pointStatuses" : [ {
"taskType" : "PreCheck"
}, {
"taskType" : "Snapshot"
}, {
"taskType" : "Cluster"
}, {
"taskType" : "PostCheck"
} ],
"lineStatuses" : [ {
"startPoint" : {
"taskType" : "PreCheck"
},
"endPoint" : {
"taskType" : "Cluster"
}
}, {
"startPoint" : {
"taskType" : "Cluster"
},
"endPoint" : {
"taskType" : "PostCheck"
}
} ]
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 表示在指定集群下创建升级流程成功。 |
错误码
请参见错误码。