runtime
diff --git a/docs/cce/api-ref/BatchCreateAddonPrecheck.html b/docs/cce/api-ref/BatchCreateAddonPrecheck.html
new file mode 100644
index 000000000..4be7f3a5a
--- /dev/null
+++ b/docs/cce/api-ref/BatchCreateAddonPrecheck.html
@@ -0,0 +1,862 @@
+
+
+Creating Add-on Check Tasks in Batches
+FunctionThis API is used to create add-on check tasks in batches in a specified cluster.
+
+ URIPOST /api/v3/projects/{project_id}/clusters/{cluster_id}/addons/precheck
+
+ Table 1 Path ParametersParameter
+ |
+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
+ |
+
+
+
+
+
+ Request Parameters
+
+
+
+ Table 3 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+Yes
+ |
+String
+ |
+Definition
+API type.
+Constraints
+The value cannot be changed.
+Range
+The value is fixed at AddonCheck.
+Default Value
+AddonCheck
+ |
+
+apiVersion
+ |
+Yes
+ |
+String
+ |
+Definition
+API version.
+Constraints
+The value cannot be changed.
+Range
+The value is fixed at v3.
+Default Value
+v3
+ |
+
+spec
+ |
+Yes
+ |
+AddonCheckSpec object
+ |
+Definition
+Details of an add-on check.
+Constraints
+N/A
+ |
+
+
+
+
+
+ Table 4 AddonCheckSpecParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+clusterID
+ |
+Yes
+ |
+String
+ |
+Definition
+Cluster ID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+addonList
+ |
+Yes
+ |
+Array of AddonInfo objects
+ |
+Definition
+Add-on check information list, including the name of the add-on template to be checked, add-on instance ID, and add-on upgrade configuration.
+Constraints
+N/A
+ |
+
+
+
+
+
+ Table 5 AddonInfoParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+addonTemplateName
+ |
+Yes
+ |
+String
+ |
+Definition
+Add-on template name.
+Constraints
+N/A
+Range
+Add-on template supported by CCE.
+Default Value
+N/A
+ |
+
+addonInstanceID
+ |
+Yes
+ |
+String
+ |
+Definition
+Add-on instance ID, which can be obtained from the items[].metadata.uid field in Listing Add-on Instances.
+Constraints
+This parameter is mandatory.
+Range
+N/A
+Default Value
+N/A
+ |
+
+targetVersion
+ |
+No
+ |
+String
+ |
+Definition
+Target version of an add-on upgrade.
+Constraints
+This parameter is mandatory in the add-on upgrade scenario.
+Range
+Add-on version provided by CCE. You can obtain the value from the items[].spec.versions.version field in Listing Add-on Templates.
+Default Value
+N/A
+ |
+
+type
+ |
+Yes
+ |
+String
+ |
+Definition
+Add-on check type.
+Constraints
+This parameter is mandatory.
+Range
+
+Default Value
+N/A
+ |
+
+values
+ |
+No
+ |
+Map<String,Object>
+ |
+Definition
+Add-on template edit or upgrade parameters (which vary depending on add-ons). Set the parameters accordingly.
+Constraints
+N/A
+ |
+
+
+
+
+
+ Response ParametersStatus code: 201
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+String
+ |
+Definition
+API type.
+Constraints
+The value cannot be changed.
+Range
+The value is fixed at AddonCheck.
+Default Value
+AddonCheck
+ |
+
+apiVersion
+ |
+String
+ |
+Definition
+API version.
+Constraints
+The value cannot be changed.
+Range
+The value is fixed at v3.
+Default Value
+v3
+ |
+
+spec
+ |
+AddonCheckSpec object
+ |
+Definition
+Details of an add-on check.
+Constraints
+N/A
+ |
+
+status
+ |
+AddonCheckStatus object
+ |
+Definition
+Results of creating an add-on check task, including the task ID for querying the add-on check result.
+Constraints
+N/A
+ |
+
+
+
+
+
+ Table 7 AddonCheckSpecParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+clusterID
+ |
+String
+ |
+Definition
+Cluster ID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+addonList
+ |
+Array of AddonInfo objects
+ |
+Definition
+Add-on check information list, including the name of the add-on template to be checked, add-on instance ID, and add-on upgrade configuration.
+Constraints
+N/A
+ |
+
+
+
+
+
+ Table 8 AddonInfoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+addonTemplateName
+ |
+String
+ |
+Definition
+Add-on template name.
+Constraints
+N/A
+Range
+Add-on template supported by CCE.
+Default Value
+N/A
+ |
+
+addonInstanceID
+ |
+String
+ |
+Definition
+Add-on instance ID, which can be obtained from the items[].metadata.uid field in Listing Add-on Instances.
+Constraints
+This parameter is mandatory.
+Range
+N/A
+Default Value
+N/A
+ |
+
+targetVersion
+ |
+String
+ |
+Definition
+Target version of an add-on upgrade.
+Constraints
+This parameter is mandatory in the add-on upgrade scenario.
+Range
+Add-on version provided by CCE. You can obtain the value from the items[].spec.versions.version field in Listing Add-on Templates.
+Default Value
+N/A
+ |
+
+type
+ |
+String
+ |
+Definition
+Add-on check type.
+Constraints
+This parameter is mandatory.
+Range
+
+Default Value
+N/A
+ |
+
+values
+ |
+Map<String,Object>
+ |
+Definition
+Add-on template edit or upgrade parameters (which vary depending on add-ons). Set the parameters accordingly.
+Constraints
+N/A
+ |
+
+
+
+
+
+ Table 9 AddonCheckStatusParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+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 10 AddonCheckTaskParameter
+ |
+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 12 CheckTaskSpecParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+addonTargetVersion
+ |
+String
+ |
+Definition
+Target version of an add-on upgrade.
+Range
+N/A
+ |
+
+
+
+
+
+ Table 13 CheckTaskStatusParameter
+ |
+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 14 CheckTaskRiskParameter
+ |
+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 RequestsCreate a CoreDNS add-on check task and set the check type to add-on inspection.
+ POST /api/v3/projects/{project_id}/clusters/{cluster_id}/addons/precheck
+
+{
+ "kind" : "AddonCheck",
+ "apiVersion" : "v3",
+ "spec" : {
+ "clusterID" : "6b400e1c-4368-11f0-ba56-0255ac100037",
+ "addonList" : [ {
+ "addonTemplateName" : "coredns",
+ "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
+ "type" : "addonStatic"
+ } ]
+ }
+}
+
+ Example ResponsesStatus code: 201
+ The add-on check tasks have been created in batches in the cluster.
+ {
+ "kind" : "AddonCheck",
+ "apiVersion" : "v3",
+ "spec" : {
+ "clusterID" : "6b400e1c-4368-11f0-ba56-0255ac100037",
+ "addonList" : [ {
+ "addonTemplateName" : "coredns",
+ "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
+ "type" : "addonUpgrade",
+ "values" : {
+ "basic" : {
+ "cluster_ip" : "10.247.3.10",
+ "image_version" : "1.17.15",
+ "platform" : "linux-amd64",
+ "rbac_enabled" : true,
+ "swr_addr" : "",
+ "swr_user" : "hwofficial"
+ },
+ "custom" : {
+ "cluster_id" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
+ "stub_domains" : { },
+ "tenant_id" : "0504201b6c80256b2f08c0099f0c8fe4",
+ "upstream_nameservers" : [ ]
+ },
+ "flavor" : {
+ "name" : 2500,
+ "replicas" : 2,
+ "resources" : [ {
+ "limitsCpu" : "500m",
+ "limitsMem" : "512Mi",
+ "name" : "coredns",
+ "requestsCpu" : "500m",
+ "requestsMem" : "512Mi"
+ } ]
+ }
+ }
+ } ]
+ },
+ "status" : {
+ "items" : [ {
+ "metadata" : {
+ "type" : "addonUpgrade",
+ "taskID" : "22386048-d955-4409-bc71-20cc2b774245",
+ "addonTemplateName" : "coredns",
+ "addonInstanceName" : "cceaddon-coredns",
+ "addonInstanceID" : "8fcaa506-809d-4f33-91b3-b27efcbeb540",
+ "createTimeStamp" : "2025-08-13T11:24:37.312017086+08:00"
+ },
+ "spec" : {
+ "addonTargetVersion" : "1.27.1"
+ },
+ "status" : {
+ "status" : "Init",
+ "riskList" : [ {
+ "riskName" : "K8sResourceModified",
+ "status" : "Init",
+ "level" : "Warning"
+ }, {
+ "riskName" : "AddonValidate",
+ "status" : "Init",
+ "level" : "Warning"
+ }, {
+ "riskName" : "AddonStatus",
+ "status" : "Init",
+ "level" : "Warning"
+ } ]
+ }
+ } ]
+ }
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+201
+ |
+The add-on check tasks have been created in batches in the cluster.
+ |
+
+
+
+
+
+
+ Deleting a Job
+FunctionThis API is used to delete a job in a specified project.
+
+ URIDELETE /api/v2/projects/{project_id}/jobs/{job_id}
+
+ Table 1 Path ParametersParameter
+ |
+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
+ |
+
+job_id
+ |
+Yes
+ |
+String
+ |
+Definition
+Job ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 204
+ The job has been deleted.
+ None
+
+
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+204
+ |
+The job has been deleted.
+ |
+
+
+
+
+
+
+ Obtaining Job Details
+FunctionThis API is used to obtain the details of a job in a specified project.
+
+ URIGET /api/v2/projects/{project_id}/jobs/{job_id}
+
+ Table 1 Path ParametersParameter
+ |
+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
+ |
+
+job_id
+ |
+Yes
+ |
+String
+ |
+Definition
+Job ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+String
+ |
+Definition
+API type.
+Constraints
+N/A
+Range
+N/A
+Default Value
+Job
+ |
+
+apiVersion
+ |
+String
+ |
+Definition
+API version.
+Constraints
+N/A
+Range
+N/A
+Default Value
+v2
+ |
+
+metadata
+ |
+V2JobTypeObject object
+ |
+Definition
+Job metadata.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+spec
+ |
+V2JobSpec object
+ |
+Definition
+Job details.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+status
+ |
+V2JobStatus object
+ |
+Definition
+Job status.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 4 V2JobSpecParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+String
+ |
+Definition
+Job type.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+clusteruid
+ |
+String
+ |
+Definition
+Cluster ID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+resourceid
+ |
+String
+ |
+Definition
+Resource ID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+resourcename
+ |
+String
+ |
+Definition
+Resource name.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+extendparam
+ |
+Map<String,String>
+ |
+Definition
+Job scale-out parameters.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+subjobs
+ |
+Array of V2Job objects
+ |
+Definition
+Subjob details list.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 5 V2JobParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+String
+ |
+Definition
+API type.
+Constraints
+N/A
+Range
+N/A
+Default Value
+Job
+ |
+
+apiVersion
+ |
+String
+ |
+Definition
+API version.
+Constraints
+N/A
+Range
+N/A
+Default Value
+v2
+ |
+
+metadata
+ |
+V2JobTypeObject object
+ |
+Definition
+Job metadata.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+spec
+ |
+V2JobSpec object
+ |
+Definition
+Job details.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+status
+ |
+V2JobStatus object
+ |
+Definition
+Job status.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 6 V2JobTypeObjectParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+uid
+ |
+String
+ |
+Definition
+Job UUID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+creationTimestamp
+ |
+String
+ |
+Definition
+Job creation time.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+updateTimestamp
+ |
+String
+ |
+Definition
+Last update time of a job.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 7 V2JobStatusParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+status
+ |
+String
+ |
+Definition
+Job status.
+Constraints
+N/A
+Range
+Initializing: The job is not executed.
+Running: The job is being executed.
+Failed: The job fails to be executed.
+Success: The job has been executed.
+
+Default Value
+N/A
+ |
+
+reason
+ |
+String
+ |
+Definition
+Cause of a job execution failure.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+completionTime
+ |
+String
+ |
+Definition
+Job completion time.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+
+ Example ResponsesStatus code: 200
+ {
+ "kind" : "Job",
+ "apiVersion" : "v2",
+ "metadata" : {
+ "uid" : "e43c6f3b-87e6-11f0-be88-0255ac10003f",
+ "creationTimestamp" : "2025-09-02 10:23:38.987955 +0000 UTC",
+ "updateTimestamp" : "2025-09-02 11:26:03.218087 +0000 UTC"
+ },
+ "spec" : {
+ "type" : "ScaleupCluster",
+ "clusteruid" : "7ec8b73d-83db-11f0-8baa-0255ac10003e",
+ "resourceid" : "3b4410fa-87e6-11f0-be88-0255ac10003f",
+ "resourcename" : "node-iv28j9",
+ "extendparam" : {
+ "claimrollback" : "true",
+ "node.zone" : "",
+ "nodepooluid" : "",
+ "orderID" : "CS25090218238EI5V",
+ "v3-scaleup" : "true"
+ }
+ },
+ "status" : {
+ "status" : "Failed",
+ "reason" : "Something bad happened at server, recycle resource",
+ "completionTime" : "2025-09-02 11:26:03.218087 +0000 UTC"
+ }
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+Successfully obtained job details.
+ |
+
+
+
+
+
+
+ Obtaining the Add-on Check Task Results
+FunctionThis API is used to obtain the results of the add-on check tasks in a cluster.
+
+ URIGET /api/v3/projects/{project_id}/clusters/{cluster_id}/addons/precheck/tasks
+
+ Table 1 Path ParametersParameter
+ |
+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 ParametersParameter
+ |
+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
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 4 Response body parametersParameter
+ |
+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 PageInfoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+currentCount
+ |
+Integer
+ |
+Definition
+Total number of all add-on check tasks.
+Range
+N/A
+ |
+
+
+
+
+
+ Table 6 AddonCheckTaskParameter
+ |
+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 8 CheckTaskSpecParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+addonTargetVersion
+ |
+String
+ |
+Definition
+Target version of an add-on upgrade.
+Range
+N/A
+ |
+
+
+
+
+
+ Table 9 CheckTaskStatusParameter
+ |
+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 CheckTaskRiskParameter
+ |
+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 ResponsesStatus 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; "
+ } ]
+ }
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+ok
+ |
+
+
+
+
+
+
+ Obtaining the Job List
+FunctionThis API is used to obtain all jobs in a specified project.
+
+ URIGET /api/v2/projects/{project_id}/jobs
+
+ Table 1 Path ParametersParameter
+ |
+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
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+[items]
+ |
+Array of V2Job objects
+ |
+Definition
+Job details list.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 4 V2JobParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+kind
+ |
+String
+ |
+Definition
+API type.
+Constraints
+N/A
+Range
+N/A
+Default Value
+Job
+ |
+
+apiVersion
+ |
+String
+ |
+Definition
+API version.
+Constraints
+N/A
+Range
+N/A
+Default Value
+v2
+ |
+
+metadata
+ |
+V2JobTypeObject object
+ |
+Definition
+Job metadata.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+spec
+ |
+V2JobSpec object
+ |
+Definition
+Job details.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+status
+ |
+V2JobStatus object
+ |
+Definition
+Job status.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 5 V2JobTypeObjectParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+uid
+ |
+String
+ |
+Definition
+Job UUID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+creationTimestamp
+ |
+String
+ |
+Definition
+Job creation time.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+updateTimestamp
+ |
+String
+ |
+Definition
+Last update time of a job.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 6 V2JobSpecParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+String
+ |
+Definition
+Job type.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+clusteruid
+ |
+String
+ |
+Definition
+Cluster ID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+resourceid
+ |
+String
+ |
+Definition
+Resource ID.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+resourcename
+ |
+String
+ |
+Definition
+Resource name.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+extendparam
+ |
+Map<String,String>
+ |
+Definition
+Job scale-out parameters.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+subjobs
+ |
+Array of V2Job objects
+ |
+Definition
+Subjob details list.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+ Table 7 V2JobStatusParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+status
+ |
+String
+ |
+Definition
+Job status.
+Constraints
+N/A
+Range
+Initializing: The job is not executed.
+Running: The job is being executed.
+Failed: The job fails to be executed.
+Success: The job has been executed.
+
+Default Value
+N/A
+ |
+
+reason
+ |
+String
+ |
+Definition
+Cause of a job execution failure.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+completionTime
+ |
+String
+ |
+Definition
+Job completion time.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+
+ Example ResponsesStatus code: 200
+ [ {
+ "kind" : "Job",
+ "apiVersion" : "v2",
+ "metadata" : {
+ "uid" : "e43c6f3b-87e6-11f0-be88-0255ac10003f",
+ "creationTimestamp" : "2025-09-02 10:23:38.987955 +0000 UTC",
+ "updateTimestamp" : "2025-09-02 11:26:03.218087 +0000 UTC"
+ },
+ "spec" : {
+ "type" : "ScaleupCluster",
+ "clusteruid" : "7ec8b73d-83db-11f0-8baa-0255ac10003e",
+ "resourceid" : "3b4410fa-87e6-11f0-be88-0255ac10003f",
+ "resourcename" : "node-iv28j9",
+ "extendparam" : {
+ "claimrollback" : "true",
+ "node.zone" : "",
+ "nodepooluid" : "",
+ "orderID" : "CS25090218238EI5V",
+ "v3-scaleup" : "true"
+ }
+ },
+ "status" : {
+ "status" : "Failed",
+ "reason" : "Something bad happened at server, recycle resource",
+ "completionTime" : "2025-09-02 11:26:03.218087 +0000 UTC"
+ }
+} ]
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+Definition
+Job details list.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+
+
+
+
+ |
-
