Obtaining the Add-on Check Task Results
Function
This API is used to obtain the results of the add-on check tasks in a cluster.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/addons/precheck/tasks
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A |
|
cluster_id |
Yes |
String |
Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
No |
String |
Definition Add-on check type-based result selection Constraints N/A Range
Default Value N/A |
|
task_id |
No |
String |
Definition Add-on check task ID-based result selection. The ID can be obtained from the status.items[].metadata.taskID field in Creating Add-on Check Tasks in Batches. Constraints N/A Range N/A Default Value N/A |
|
addon_instance_id |
No |
String |
Definition Add-on instance ID-based result selection. The ID can be obtained from the items[].metadata.uid field in Listing Add-on Instances. Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Content-Type |
Yes |
String |
Details: The request body type or format Constraints: The GET method is not verified. Options:
Default value: N/A |
|
X-Auth-Token |
Yes |
String |
Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
kind |
String |
Definition API type. Range The value is fixed at AddonCheck. |
|
apiVersion |
String |
Definition API version. Range The value is fixed at v3. |
|
pageInfo |
PageInfo object |
Definition Pagination information of the add-on check task list. Constraints N/A |
|
items |
Array of AddonCheckTask objects |
Definition Add-on check task list, including the add-on check task ID, add-on template name, and add-on instance ID. Constraints N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
currentCount |
Integer |
Definition Total number of all add-on check tasks. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
metadata |
CheckTaskMetadata object |
Definition Basic information. Metadata is a collection of attributes. Constraints N/A |
|
spec |
CheckTaskSpec object |
Definition Target information of an add-on check, including the target version of an add-on upgrade. Constraints N/A |
|
status |
CheckTaskStatus object |
Definition Add-on check task status. Constraints N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
String |
Definition Add-on check type. Range
|
|
taskID |
String |
Definition Add-on check task ID, which is used to query the task check result. Range N/A |
|
addonTemplateName |
String |
Definition Add-on template name. Range Add-on template provided by CCE. You can obtain the value from the items[].metadata.name field in Listing Add-on Templates. |
|
addonInstanceName |
String |
Definition Add-on instance name. Range N/A |
|
addonInstanceID |
String |
Definition Add-on instance ID. Range N/A |
|
createTimeStamp |
String |
Definition Creation time of an add-on check task. Range N/A |
|
expireTimeStamp |
String |
Definition Timeout duration of an add-on check task. This field is available only for tasks in the Failed or Success state. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
addonTargetVersion |
String |
Definition Target version of an add-on upgrade. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
status |
String |
Definition Status of an add-on check. Range
|
|
message |
String |
Definition Add-on check results. Range N/A |
|
riskList |
Array of CheckTaskRisk objects |
Definition List of risk items during an add-on check. The risk items vary according to add-ons. Constraints N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
riskName |
String |
Definition Risk item name. Range N/A |
|
level |
String |
Definition Risk level. Range
|
|
status |
String |
Definition Risk item check status. Range
|
|
message |
String |
Definition Risk check result description. Range N/A |
Example Requests
None
Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
ok |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot