# 开启集群升级流程引导任务 - CreateAutopilotUpgradeWorkFlow #### 功能介绍 该API用于创建一个集群升级流程引导任务。请在调用本接口完成引导任务创建之后，通过集群升级前检查开始检查任务。 升级流程任务用于控制集群升级任务的执行流程，执行流程为 升级前检查 =\> 集群升级 =\> 升级后检查。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0099.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0327.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cce:cluster:upgrade | Write | cluster \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 账号的项目ID **默认取值：** 不涉及 | | cluster_id | 是 | String | **参数解释：** 集群ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 集群ID **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式），默认为application/json，有其他取值时会在具体接口中专门说明。 **约束限制：** GET方法不做校验 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见[获取token](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0004.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | kind | 是 | String | **参数解释：** API类型 **约束限制：** 固定值 **取值范围：** - WorkFlowTask | | apiVersion | 是 | String | **参数解释：** API版本 **约束限制：** 固定值 **取值范围：** - v3 | | spec | 是 | [WorkFlowSpec] object | **参数解释：** 集合类的元素类型，您对集群升级流程主体都在spec中给出。CCE通过spec的描述来创建或更新对象。 **约束限制：** 不涉及 | 表4WorkFlowSpec | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | clusterID | 是 | String | **参数解释：** 集群ID **约束限制：** 不涉及 **取值范围：** 不涉及 | | clusterVersion | 否 | String | **参数解释：** 当前集群版本 **约束限制：** 不涉及 **取值范围：** 不涉及 | | targetVersion | 是 | String | **参数解释：** 本次集群升级的目标版本 **约束限制：** 不涉及 **取值范围：** 不涉及 | #### 响应参数 **状态码：201** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kind | String | API类型，固定值"WorkFlowTask"，该值不可修改。 | | apiVersion | String | API版本，固定值"v3"，该值不可修改。 | | metadata | [Metadata] object | 升级流程的元数据信息 | | spec | [WorkFlowResponseSpec] object | 集合类的元素类型，您对集群升级流程主体都在spec中给出。CCE通过spec的描述来创建或更新对象。 | | status | [WorkFlowStatus] object | 集合类的元素类型，用于记录本次集群升级流程的当前状态信息，包含了集群升级流程的各个流程的执行状态 | 表6Metadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uid | String | **参数解释**： 唯一id标识 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | String | **参数解释**： 资源名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | labels | Map\ | **参数解释**： 资源标签，key/value对格式，接口保留字段，填写不会生效 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | annotations | Map\ | **参数解释**： 资源注解，由key/value组成 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | updateTimestamp | String | **参数解释**： 更新时间 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | creationTimestamp | String | **参数解释**： 创建时间 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表7WorkFlowResponseSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | clusterID | String | 集群ID | | clusterVersion | String | 当前集群版本 | | targetVersion | String | 本次集群升级的目标版本 | 表8WorkFlowStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | phase | String | 集群升级流程的执行状态： Init: 表示该升级流程中还未有任何任务开始运行 Running: 表示该升级流程中已有任务开始执行 Pending: 表示该升级流程中有任务执行失败 Success: 表示该升级流程中所有任务都已执行成功 Cancel: 表示该升级流程已被取消 | | pointStatuses | Array of [PointStatus] objects | 升级流程中的各个任务项的执行状态 | | lineStatuses | Array of [LineStatus] objects | 表示该升级流程的任务执行线路 | 表9PointStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | taskType | String | 集群升级任务类型： Cluster: 集群升级任务 PreCheck: 集群升级预检查任务 Rollback: 集群升级回归任务 Snapshot: 集群升级快照任务 PostCheck: 集群升级后检查任务 | | taskID | String | 升级任务项ID | | status | String | 集群升级状态： Init: 任务初始状态 Queuing: 任务已进入执行队列 Running: 任务开始执行 Success: 任务执行成功 Failed: 任务执行失败 | | startTimeStamp | String | 升级任务开始时间 | | endTimeStamp | String | 升级任务结束时间 | | expireTimeStamp | String | 升级任务过期时间（当前仅升级前检查任务适用） | 表10LineStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | startPoint | [Point] object | 线路起点 | | endPoint | [Point] object | 线路终点 | | critical | String | 表示是否为关键线路（关键线路未执行无法取消升级流程） | 表11Point | 参数 | 参数类型 | 描述 | |:---|:---|:---| | taskType | String | 集群升级任务类型： Cluster: 集群升级任务 PreCheck: 集群升级预检查任务 Rollback: 集群升级回归任务 Snapshot: 集群升级快照任务 PostCheck: 集群升级后检查任务 | #### 请求示例 开启升级集群至v1.28版本的流程 ``` POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/operation/upgradeworkflows { "kind" : "WorkFlowTask", "apiVersion" : "v3", "spec" : { "targetVersion" : "v1.23", "clusterID" : "7378a198-a3fe-11eb-ad37-0255ac100b07" } } ``` #### 响应示例 **状态码：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" } } ] } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 开启升级集群至v1.28版本的流程 ``` 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 CreateAutopilotUpgradeWorkFlowSolution { 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("")) .build(); CreateAutopilotUpgradeWorkFlowRequest request = new CreateAutopilotUpgradeWorkFlowRequest(); request.withClusterId("{cluster_id}"); CreateUpgradeWorkFlowRequestBody body = new CreateUpgradeWorkFlowRequestBody(); WorkFlowSpec specbody = new WorkFlowSpec(); specbody.withClusterID("7378a198-a3fe-11eb-ad37-0255ac100b07") .withTargetVersion("v1.23"); body.withSpec(specbody); body.withApiVersion("v3"); body.withKind("WorkFlowTask"); request.withBody(body); try { CreateAutopilotUpgradeWorkFlowResponse response = client.createAutopilotUpgradeWorkFlow(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()); } } } ``` - [Python] 开启升级集群至v1.28版本的流程 ``` # 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("")) \ .build() try: request = CreateAutopilotUpgradeWorkFlowRequest() request.cluster_id = "{cluster_id}" specbody = WorkFlowSpec( cluster_id="7378a198-a3fe-11eb-ad37-0255ac100b07", target_version="v1.23" ) request.body = CreateUpgradeWorkFlowRequestBody( spec=specbody, api_version="v3", kind="WorkFlowTask" ) response = client.create_autopilot_upgrade_work_flow(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 开启升级集群至v1.28版本的流程 ``` 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("")). WithCredential(auth). Build()) request := &model.CreateAutopilotUpgradeWorkFlowRequest{} request.ClusterId = "{cluster_id}" clusterIDSpec:= "7378a198-a3fe-11eb-ad37-0255ac100b07" specbody := &model.WorkFlowSpec{ ClusterID: &clusterIDSpec, TargetVersion: "v1.23", } request.Body = &model.CreateUpgradeWorkFlowRequestBody{ Spec: specbody, ApiVersion: "v3", Kind: "WorkFlowTask", } response, err := client.CreateAutopilotUpgradeWorkFlow(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCE/sdk?api=CreateAutopilotUpgradeWorkFlow)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | 表示在指定集群下创建升级流程成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cce-autopilot/ErrorCode.html)。