更新指定集群升级引导任务状态
功能介绍
该API用于更新指定集群升级引导任务状态,当前仅适用于取消升级流程
调用该API时升级流程引导任务状态不能为进行中(running) 已完成(success) 已取消(cancel),升级子任务状态不能为running(进行中) init(已初始化) pause(任务被暂停) queue(队列中)
调用方法
请参见如何调用API。
URI
PATCH /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows/{upgrade_workflow_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
cluster_id |
是 |
String |
参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
upgrade_workflow_id |
是 |
String |
集群升级任务引导流程ID,获取方式请参见如何获取接口URI中参数。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式) 约束限制: GET方法不做校验 取值范围:
默认取值: 不涉及 |
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
status |
否 |
status object |
参数解释: 更新后workflow的状态(当前仅支持Cancel) 约束限制: 不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
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 |
升级任务过期时间(当前仅升级前检查任务适用) |
请求示例
取消升级流程
PATCH /api/v3/projects/47eb1d64cbeb45cfa01ae20af4f4b563/clusters/f9960c6b-8e60-11ee-9754-0255ac100b05/operation/upgradeworkflows/d0b7e319-8172-424c-86ea-543cd23f9756 { "status" : { "phase" : "Cancel" } }
响应示例
状态码: 200
表示更新集群升级引导任务状态成功
{ "kind" : "WorkFlowTask", "apiVersion" : "v3", "metadata" : { "uid" : "c271e39e-1a6e-4d3d-8fa8-2a36329c68d1", "creationTimestamp" : "2023-11-25 06:32:34.923248 +0000 UTC", "updateTimestamp" : "2023-11-25 07:49:30.281911 +0000 UTC" }, "spec" : { "clusterID" : "b4b9e60f-8aa2-11ee-af09-0255ac10004f", "clusterVersion" : "v1.17.17-r0", "targetVersion" : "v1.19.16-r80" }, "status" : { "phase" : "Cancel", "pointStatuses" : [ { "taskType" : "PreCheck", "taskID" : "f61e008c-1600-41c0-9bde-121de5a30660", "status" : "Success", "startTimeStamp" : "2023-11-25 07:20:04.592972 +0000 UTC", "endTimeStamp" : "2023-11-25 07:21:05.518966 +0000 UTC", "expireTimeStamp" : "2023-11-25 08:21:05.518966 +0000 UTC" }, { "taskType" : "Snapshot" }, { "taskType" : "Cluster", "taskID" : "6d799ff6-3afe-4242-80b4-6f0a0fa746cb", "status" : "Failed", "startTimeStamp" : "2023-11-25 07:49:30.283459 +0000 UTC", "endTimeStamp" : "2023-11-25 07:58:35.507243 +0000 UTC" }, { "taskType" : "PostCheck" } ], "lineStatuses" : [ { "startPoint" : { "taskType" : "PreCheck" }, "endPoint" : { "taskType" : "Cluster" } }, { "startPoint" : { "taskType" : "Cluster" }, "endPoint" : { "taskType" : "PostCheck" } } ] } }
SDK代码示例
SDK代码示例如下。
取消升级流程
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; public class UpgradeWorkFlowUpdateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); UpgradeWorkFlowUpdateRequest request = new UpgradeWorkFlowUpdateRequest(); request.withClusterId("{cluster_id}"); request.withUpgradeWorkflowId("{upgrade_workflow_id}"); UpgradeWorkFlowUpdateRequestBody body = new UpgradeWorkFlowUpdateRequestBody(); UpgradeWorkFlowUpdateRequestBodyStatus statusbody = new UpgradeWorkFlowUpdateRequestBodyStatus(); statusbody.withPhase(UpgradeWorkFlowUpdateRequestBodyStatus.PhaseEnum.fromValue("Cancel")); body.withStatus(statusbody); request.withBody(body); try { UpgradeWorkFlowUpdateResponse response = client.upgradeWorkFlowUpdate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
取消升级流程
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpgradeWorkFlowUpdateRequest() request.cluster_id = "{cluster_id}" request.upgrade_workflow_id = "{upgrade_workflow_id}" statusbody = UpgradeWorkFlowUpdateRequestBodyStatus( phase="Cancel" ) request.body = UpgradeWorkFlowUpdateRequestBody( status=statusbody ) response = client.upgrade_work_flow_update(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
取消升级流程
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpgradeWorkFlowUpdateRequest{} request.ClusterId = "{cluster_id}" request.UpgradeWorkflowId = "{upgrade_workflow_id}" phaseStatus:= model.GetUpgradeWorkFlowUpdateRequestBodyStatusPhaseEnum().CANCEL statusbody := &model.UpgradeWorkFlowUpdateRequestBodyStatus{ Phase: &phaseStatus, } request.Body = &model.UpgradeWorkFlowUpdateRequestBody{ Status: statusbody, } response, err := client.UpgradeWorkFlowUpdate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
表示更新集群升级引导任务状态成功 |
错误码
请参见错误码。