Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Upgrade/ Obtaining Details About a Pre-upgrade Check Task of a Cluster

Updated on 2024-04-23 GMT+08:00

View PDF

Obtaining Details About a Pre-upgrade Check Task of a Cluster

Function

Obtain details about a pre-upgrade check task of a cluster. The task ID is obtained from the uid field in the response body after the cluster check API is called.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
task_id	Yes	String	Upgrade task ID, obtained from the uid field in the response body after the cluster upgrade API is called.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
apiVersion	String	API version, which defaults to v3
kind	String	Resource type, which defaults to PreCheckTask
metadata	PrecheckTaskMetadata object	Metadata of a pre-upgrade check task
spec	PrecheckSpec object	Information of a pre-upgrade check task
status	PrecheckStatus object	Status of a pre-upgrade check task

**Table 3** PrecheckTaskMetadata
Parameter	Type	Description
uid	String	Task ID
creationTimestamp	String	Time when the task was created
updateTimestamp	String	Time when the task was updated

**Table 4** PrecheckSpec
Parameter	Type	Description
clusterID	String	Cluster ID
clusterVersion	String	Cluster version
targetVersion	String	Target Version
skippedCheckItemList	Array of skippedCheckItemList objects	Skipped check items

**Table 5** skippedCheckItemList
Parameter	Type	Description
name	String	Names of the skipped check items
resourceSelector	resourceSelector object	Resource tag selector. This parameter is available only for node check, but not for cluster check or add-on check.

**Table 6** resourceSelector
Parameter	Type	Description
key	String	Tag key. Options: node.uid: node UID
values	Array of strings	Tag values
operator	String	Logical operator of a tag. Options: In

**Table 7** PrecheckStatus
Parameter	Type	Description
phase	String	Status. Options: Init: initializing Running Success Failed Error
expireTimeStamp	String	Check result expiration time
message	String	Information, which typically indicates the log for execution errors
clusterCheckStatus	clusterCheckStatus object	Status of a cluster restrictions check
addonCheckStatus	addonCheckStatus object	Status of an add-on check
nodeCheckStatus	nodeCheckStatus object	Node check status

**Table 8** clusterCheckStatus
Parameter	Type	Description
phase	String	Status. Options: Init: initializing Running Success Failed
itemsStatus	Array of PreCheckItemStatus objects	Compliance set by check item

**Table 9** addonCheckStatus
Parameter	Type	Description
phase	String	Status. Options: Init: initializing Running Success Failed
itemsStatus	Array of PreCheckItemStatus objects	Compliance set by check item

**Table 10** nodeCheckStatus
Parameter	Type	Description
phase	String	Status. Options: Init: initializing Running Success Failed
nodeStageStatus	Array of NodeStageStatus objects	Node check status

**Table 11** NodeStageStatus
Parameter	Type	Description
nodeInfo	NodeInfo object	Node information
itemsStatus	Array of PreCheckItemStatus objects	Compliance set by check item

**Table 12** NodeInfo
Parameter	Type	Description
uid	String	Node UID
name	String	Node name
status	String	Status
nodeType	String	Node type

**Table 13** PreCheckItemStatus
Parameter	Type	Description
name	String	Check item
kind	String	Check item type. Options: Exception: exceptions that need to be resolved by you Risk: risks that can be skipped after you confirm them
group	String	Check item group. Options: LimitCheck: cluster limit check MasterCheck: master node check NodeCheck: worker node check AddonCheck: add-on check ExecuteException: process error check
level	String	Check item severity. Options: Info: information Warning Fatal: critical
phase	String	Status. Options: Init: initializing Running Success Failed
message	String	Information
riskSource	riskSource object	Risk item
errorCodes	Array of strings	Error code set

**Table 14** riskSource
Parameter	Type	Description
configurationRisks	Array of configurationRisks objects	Configuration risk
deprecatedAPIRisks	Array of deprecatedAPIRisks objects	Deprecated API risk
nodeRisks	Array of nodeRisks objects	Node risk
addonRisks	Array of addonRisks objects	Add-on risk

**Table 15** configurationRisks
Parameter	Type	Description
package	String	Component
sourceFile	String	How to Obtain
nodeMsg	String	Node information
field	String	Parameter Value
operation	String	Change an operation type.
originalValue	String	Original Value
value	String	Current Value

**Table 16** deprecatedAPIRisks
Parameter	Type	Description
url	String	Request path, for example, /apis/policy/v1beta1/podsecuritypolicies
userAgent	String	Client information

**Table 17** nodeRisks
Parameter	Type	Description
NodeID	String	Worker node ID

**Table 18** addonRisks
Parameter	Type	Description
addonTemplateName	String	Name of the add-on template
alias	String	Add-on alias

Example Requests

None

Example Responses

Status code: 200

The details about a pre-upgrade check task of a cluster are obtained.

{
  "kind" : "PreCheckTask",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "f61e008c-1600-41c0-9bde-121de5a30660",
    "creationTimestamp" : "2023-11-25 07:20:04.592972 +0000 UTC",
    "updateTimestamp" : "2023-11-25 07:21:05.518966 +0000 UTC"
  },
  "spec" : {
    "clusterVersion" : "v1.19.16-r4",
    "targetVersion" : "v1.23.5-r0"
  },
  "status" : {
    "phase" : "Success",
    "expireTimeStamp" : "2023-11-25 08:21:05.518966 +0000 UTC",
    "clusterCheckStatus" : {
      "phase" : "Success",
      "itemsStatus" : [ {
        "name" : "DeprecatedApiCheck",
        "kind" : "Risk",
        "group" : "LimitCheck",
        "level" : "Info",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      }, {
        "name" : "NodeContainerdPodRestartRisk",
        "kind" : "Risk",
        "group" : "LimitCheck",
        "level" : "Warning",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      }, {
        "name" : "ResiduePackageVersion",
        "kind" : "Exception",
        "group" : "LimitCheck",
        "level" : "Fatal",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      } ]
    },
    "addonCheckStatus" : {
      "phase" : "Success",
      "itemsStatus" : [ {
        "name" : "AddonLimit",
        "kind" : "Exception",
        "group" : "AddonCheck",
        "level" : "Warning",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      }, {
        "name" : "CoreDNSConfLimit",
        "kind" : "Exception",
        "group" : "AddonCheck",
        "level" : "Fatal",
        "phase" : "Success",
        "message" : "check item succeed",
        "riskSource" : { }
      } ]
    },
    "nodeCheckStatus" : {
      "phase" : "Success"
    }
  }
}