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.

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/addons/precheck/tasks

**Table 1** Path Parameters
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition Add-on check type-based result selection Constraints N/A Range addonStatic: add-on inspection when the add-on is running addonUpgrade: add-on check before an upgrade 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

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Details: The request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) 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

**Table 4** Response body parameters
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

**Table 5** PageInfo
Parameter	Type	Description
currentCount	Integer	Definition Total number of all add-on check tasks. Range N/A

**Table 6** AddonCheckTask
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

**Table 7** CheckTaskMetadata
Parameter	Type	Description
type	String	Definition Add-on check type. Range addonStatic: add-on check when the add-on is running addonUpgrade: add-on check before an upgrade
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

**Table 8** CheckTaskSpec
Parameter	Type	Description
addonTargetVersion	String	Definition Target version of an add-on upgrade. Range N/A

**Table 9** CheckTaskStatus
Parameter	Type	Description
status	String	Definition Status of an add-on check. Range Init: The add-on check is initialized. Running: The add-on check is in progress. Failed: The add-on check is complete, and risks are found. Success: The add-on check is complete, and no risks are found.
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

**Table 10** CheckTaskRisk
Parameter	Type	Description
riskName	String	Definition Risk item name. Range N/A
level	String	Definition Risk level. Range Warning: medium risk, which can be skipped Fatal: high risk, which cannot be skipped
status	String	Definition Risk item check status. Range Init: The risk item check is initialized. Running: The risk item check is in progress. Failed: The risk item check is complete, and risks are found. Success: The risk item check is complete, and no risks are found.
message	String	Definition Risk check result description. Range N/A

Example Requests

None

Example Responses

Status code: 200

{
  "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; "
    } ]
  }
}