Performing a Post-upgrade Check

Function

This API is used to perform a post-upgrade check, which is used by the customer to check the cluster status after an upgrade and provide feedback after services are restored. Use this API with the console.

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

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/postcheck

**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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
apiVersion	Yes	String	Definition: API version. The value is fixed at v3 and cannot be changed. Constraints: The value cannot be changed. Range: v3 Default Value: v3
kind	Yes	String	Definition: API type. The value is fixed at PostCheckTask and cannot be changed. Constraints: The value cannot be changed. Range: PostCheckTask Default Value: PostCheckTask
spec	Yes	PostcheckResponseSpec object	Definition: spec indicates the configuration confirmed after an upgrade. Constraints: N/A Range: N/A Default Value: N/A

**Table 3** PostcheckResponseSpec
Parameter	Mandatory	Type	Description
clusterID	No	String	Definition: Cluster ID Constraints: N/A Range: N/A Default Value: N/A
clusterVersion	No	String	Definition: Source cluster version Constraints: N/A Range: N/A Default Value: N/A
targetVersion	No	String	Definition: Current cluster version Constraints: N/A Range: N/A Default Value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
apiVersion	String	Definition: API version Range: N/A
kind	String	Definition: Resource type. Range: N/A
metadata	PostcheckCluserResponseMetadata object	Definition: Post-upgrade check metadata Range: N/A
spec	PostcheckSpec object	Definition: Configuration confirmed after a cluster upgrade Range: N/A
status	status object	Definition: Status confirmed after a cluster upgrade Range: N/A

**Table 5** PostcheckCluserResponseMetadata
Parameter	Type	Description
uid	String	Definition: Task ID Range: N/A

**Table 6** PostcheckSpec
Parameter	Type	Description
clusterID	String	Definition: Cluster ID Range: N/A
clusterVersion	String	Definition: Source cluster version Range: N/A
targetVersion	String	Definition: Current cluster version Range: Supported cluster versions

**Table 7** status
Parameter	Type	Description
phase	String	Definition: Status Range: Success Failed Error: An error occurred.

Example Requests

Post-upgrade check

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/postcheck

{
  "kind" : "PostCheckTask",
  "apiVersion" : "v3",
  "spec" : {
    "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c",
    "clusterVersion" : "v1.15.11-r1",
    "targetVersion" : "v1.19.16-r80"
  }
}

Example Responses

Status code: 200

Cluster post-upgrade check succeeded.

{
  "kind" : "PostCheckTask",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "e99fedf8-348c-4084-b0fd-81bf187df4e0"
  },
  "spec" : {
    "clusterID" : "8978deaa-1743-11ee-8e46-0255ac10004c",
    "clusterVersion" : "v1.15.11-r1",
    "targetVersion" : "v1.19.16-r80"
  },
  "status" : {
    "phase" : "Success"
  }
}