获取UpgradeWorkFlows列表 - ListUpgradeWorkFlows
功能介绍
获取历史集群升级引导任务列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /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。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| kind | String | 参数解释: API类型,固定值"List",该值不可修改 取值范围: |
| apiVersion | String | 参数解释: API版本,固定值"v3",该值不可修改 取值范围: |
| items | Array of UpgradeWorkFlow objects | 参数解释: 升级工作流列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 集群升级流程的执行状态 取值范围: |
| pointStatuses | Array of PointStatus objects | 参数解释: 升级流程中的各个任务项的执行状态 取值范围: 不涉及 |
| lineStatuses | Array of LineStatus objects | 参数解释: 表示该升级流程的任务执行线路 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| taskType | String | 参数解释: 集群升级任务类型 取值范围: |
| taskID | String | 参数解释: 升级任务项ID 取值范围: 不涉及 |
| status | String | 参数解释: 集群升级状态 取值范围: |
| startTimeStamp | String | 参数解释: 升级任务开始时间 取值范围: 不涉及 |
| endTimeStamp | String | 参数解释: 升级任务结束时间 取值范围: 不涉及 |
| expireTimeStamp | String | 参数解释: 升级任务过期时间(当前仅升级前检查任务适用) 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
获取历史集群升级引导任务列表成功。
{
"apiVersion" : "v3",
"kind" : "List",
"items" : [ {
"kind" : "WorkFlowTask",
"apiVersion" : "v3",
"metadata" : {
"uid" : "730f5577-38ef-448c-b4a7-c6878fbefdda",
"creationTimestamp" : "2023-11-24 08:39:15.894417 +0000 UTC",
"updateTimestamp" : "2023-11-25 02:57:25.718567 +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"
}, {
"taskType" : "Snapshot"
}, {
"taskType" : "Cluster"
}, {
"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 | 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 ListUpgradeWorkFlowsSolution { 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(); ListUpgradeWorkFlowsRequest request = new ListUpgradeWorkFlowsRequest(); request.withClusterId("{cluster_id}"); try { ListUpgradeWorkFlowsResponse response = client.listUpgradeWorkFlows(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 | # 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 = ListUpgradeWorkFlowsRequest() request.cluster_id = "{cluster_id}" response = client.list_upgrade_work_flows(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 47 48 49 50 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cce.NewCceClient(hcClient) request := &model.ListUpgradeWorkFlowsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListUpgradeWorkFlows(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 获取历史集群升级引导任务列表成功。 |
错误码
请参见错误码。