Obtaining a List of Pre-upgrade Check Tasks of a Cluster
Function
Obtain a list of pre-upgrade check tasks of a cluster.
Calling Method
For details, see Calling APIs.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/precheck/tasks
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. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
apiVersion |
String |
API version, which defaults to v3 |
kind |
String |
Type |
metadata |
Metadata object |
Basic information about the object. Metadata is a collection of attributes. |
items |
Array of PrecheckClusterTask objects |
Cluster check tasks |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Unique ID. |
name |
String |
Resource name |
labels |
Map<String,String> |
Resource labels in key-value pairs. This is a reserved field and does not take effect. |
annotations |
Map<String,String> |
Resource annotations in the format of key-value pairs. |
updateTimestamp |
String |
Update time. |
creationTimestamp |
String |
Creation time. |
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 |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Task ID |
creationTimestamp |
String |
Time when the task was created |
updateTimestamp |
String |
Time when the task was updated |
Parameter |
Type |
Description |
---|---|---|
clusterID |
String |
Cluster ID |
clusterVersion |
String |
Cluster version |
targetVersion |
String |
Target Version |
skippedCheckItemList |
Array of skippedCheckItemList objects |
Skipped check items |
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. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. Options:
|
values |
Array of strings |
Tag values |
operator |
String |
Logical operator of a tag. Options:
|
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
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 |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
itemsStatus |
Array of PreCheckItemStatus objects |
Compliance set by check item |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
itemsStatus |
Array of PreCheckItemStatus objects |
Compliance set by check item |
Parameter |
Type |
Description |
---|---|---|
phase |
String |
Status. Options:
|
nodeStageStatus |
Array of NodeStageStatus objects |
Node check status |
Parameter |
Type |
Description |
---|---|---|
nodeInfo |
NodeInfo object |
Node information |
itemsStatus |
Array of PreCheckItemStatus objects |
Compliance set by check item |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Node UID |
name |
String |
Node name |
status |
String |
Status |
nodeType |
String |
Node type |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Check item |
kind |
String |
Check item type. Options:
|
group |
String |
Check item group. Options:
|
level |
String |
Check item severity. Options:
|
phase |
String |
Status. Options:
|
message |
String |
Information |
riskSource |
riskSource object |
Risk item |
errorCodes |
Array of strings |
Error code set |
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 |
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 |
Example Requests
None
Example Responses
Status code: 200
The list of pre-upgrade check tasks of a cluster is obtained.
{ "kind" : "List", "apiVersion" : "v3", "metadata" : { }, "items" : [ { "kind" : "PreCheckTask", "apiVersion" : "v3", "metadata" : { "uid" : "10b52d23-080a-4b7d-bf83-64b4687ca786", "creationTimestamp" : "2023-12-16 07:07:11.099111 +0000 UTC", "updateTimestamp" : "2023-12-16 07:09:10.425622 +0000 UTC" }, "spec" : { "clusterVersion" : "v1.23.5-r0", "targetVersion" : "v1.23.11-r0" }, "status" : { "phase" : "Failed", "clusterCheckStatus" : { "phase" : "Success", "itemsStatus" : [ { "name" : "DeprecatedApiCheck", "kind" : "Risk", "group" : "LimitCheck", "level" : "Info", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } }, { "name" : "BlackLimit", "kind" : "Exception", "group" : "LimitCheck", "level" : "Fatal", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } }, { "name" : "MasterSSH", "kind" : "Exception", "group" : "LimitCheck", "level" : "Fatal", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } }, { "name" : "ReleaseLimit", "kind" : "Exception", "group" : "LimitCheck", "level" : "Warning", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } }, { "name" : "ClusterNoArm", "kind" : "Exception", "group" : "LimitCheck", "level" : "Warning", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } } ] }, "addonCheckStatus" : { "phase" : "Failed", "itemsStatus" : [ { "name" : "AddonLimit", "kind" : "Exception", "group" : "AddonCheck", "level" : "Warning", "phase" : "Failed", "message" : "addon [ CoreDNS,CCE Container Storage (Everest) ] status is abnormal, check and try again", "riskSource" : { "addonRisks" : [ { "addonTemplateName" : "coredns", "alias" : "CoreDNS" }, { "addonTemplateName" : "everest", "alias" : "CCE Container Storage (Everest)" } ] } }, { "name" : "CoreDNSConfLimit", "kind" : "Exception", "group" : "AddonCheck", "level" : "Fatal", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } }, { "name" : "EverestLimitHungVersion", "kind" : "Risk", "group" : "AddonCheck", "level" : "Fatal", "phase" : "Success", "message" : "check item succeed", "riskSource" : { } } ] }, "nodeCheckStatus" : { "phase" : "Success" } } } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
The list of pre-upgrade check tasks of a cluster is obtained. |
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