获取插件检查任务结果列表 - ListAddonPrecheckTasks
功能介绍
获取集群下插件检查任务结果列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/addons/precheck/tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
|
cluster_id |
是 |
String |
参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
参数解释: 根据插件检查类型筛选结果 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
task_id |
否 |
String |
参数解释: 根据插件检查任务ID筛选结果,插件检查任务ID可以通过批量创建插件检查任务中的status.items[].metadata.taskID字段获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
addon_instance_id |
否 |
String |
参数解释: 根据插件实例ID筛选结果,实例ID可以通过获取AddonInstance列表中的items[].metadata.uid字段获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式) 约束限制: GET方法不做校验 取值范围:
默认取值: 不涉及 |
|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
kind |
String |
参数解释: API类型 取值范围: 固定值"AddonCheck" |
|
apiVersion |
String |
参数解释: API版本 取值范围: 固定值"v3" |
|
pageInfo |
PageInfo object |
参数解释: 插件任务列表的分页信息 约束限制: 不涉及 |
|
items |
Array of AddonCheckTask objects |
参数解释: 插件检查任务信息列表,包含了插件检查任务ID,插件模板名称,插件实例ID等。 约束限制: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metadata |
CheckTaskMetadata object |
参数解释: 基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 约束限制: 不涉及 |
|
spec |
CheckTaskSpec object |
参数解释: 插件检查目标信息,包含插件升级的目标版本 约束限制: 不涉及 |
|
status |
CheckTaskStatus object |
参数解释: 插件检查任务状态信息 约束限制: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释: 插件检查类型 取值范围:
|
|
taskID |
String |
参数解释: 插件检查任务ID,用于任务检查结果查询 取值范围: 不涉及 |
|
addonTemplateName |
String |
参数解释: 插件模板名称 取值范围: cce服务提供的插件模板,可以通过查询AddonTemplates列表中的items[].metadata.name字段获取 |
|
addonInstanceName |
String |
参数解释: 插件实例名称 取值范围: 不涉及 |
|
addonInstanceID |
String |
参数解释: 插件实例ID 取值范围: 不涉及 |
|
createTimeStamp |
String |
参数解释: 插件检查任务创建时间 取值范围: 不涉及 |
|
expireTimeStamp |
String |
参数解释: 插件检查任务超时时间,仅终态(Failed/Success)任务存在此字段 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 插件检查状态 取值范围:
|
|
message |
String |
参数解释: 插件检查结果信息 取值范围: 不涉及 |
|
riskList |
Array of CheckTaskRisk objects |
参数解释: 插件检查风险项列表,不同插件对应的风险检查项不同。 约束限制: 不涉及 |
请求示例
无
响应示例
状态码:200
ok
{
"kind" : "AddonCheck",
"apiVersion" : "v3",
"pageInfo" : {
"currentCount" : 1
},
"items" : {
"metadata" : {
"type" : "addonUpgrade",
"taskID" : "8ca259cc-553b-11e9-926f-0255ac101a31",
"addonTemplateName" : "coredns",
"addonInstanceName" : "cceaddon-coredns",
"addonInstanceID" : "1d43577d-4b50-4723-b05b-2121f47cb219",
"createTimestamp" : "2025-08-05T17:10:44.648388+08:00"
},
"spec" : {
"addonTargetVersion" : "3.0.4"
},
"status" : {
"status" : "Failed",
"message" : "Addon task check finish"
},
"riskList" : [ {
"riskName" : "AddonStatus",
"status" : "Failed",
"level" : "Warning",
"message" : "addon status(abnormal) is not running"
}, {
"riskName" : "AddonValidate",
"status" : "Failed",
"level" : "Fatal",
"message" : "configmap coredns had been modified, failed to ensure the consistency of corefile between current and recorded, the manually modified configuration by user may be lost if upgrade continue: 1. rollback current corefile; 2. set parameterSyncStrategy to force to force take over; 3. set parameterSyncStrategy to inherit to auto inherit your configuration; "
} ]
}
}
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 ListAddonPrecheckTasksSolution { 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(); ListAddonPrecheckTasksRequest request = new ListAddonPrecheckTasksRequest(); request.withClusterId("{cluster_id}"); try { ListAddonPrecheckTasksResponse response = client.listAddonPrecheckTasks(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 = ListAddonPrecheckTasksRequest() request.cluster_id = "{cluster_id}" response = client.list_addon_precheck_tasks(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 |
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.ListAddonPrecheckTasksRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListAddonPrecheckTasks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
ok |
错误码
请参见错误码。