Updated on 2024-11-06 GMT+08:00

Post-upgrade Check

Function

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.

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

Details:

API version

Constraints:

The value is fixed.

Options:

  • v3

kind

Yes

String

Details:

API type

Constraints:

The value is fixed.

Options:

  • PostCheckTask

spec

Yes

PostcheckResponseSpec object

spec indicates the configuration confirmed after an upgrade.

Table 3 PostcheckResponseSpec

Parameter

Mandatory

Type

Description

clusterID

No

String

Cluster ID

clusterVersion

No

String

Source cluster version

targetVersion

No

String

Current cluster version

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

apiVersion

String

API version

kind

String

Resource type

metadata

PostcheckCluserResponseMetadata object

Post-upgrade check metadata

spec

PostcheckSpec object

Configuration confirmed after a cluster upgrade

status

status object

Status confirmed after a cluster upgrade

Table 5 PostcheckCluserResponseMetadata

Parameter

Type

Description

uid

String

Task ID

Table 6 PostcheckSpec

Parameter

Type

Description

clusterID

String

Details:

Cluster ID

Constraints:

None

Options:

N/A

clusterVersion

String

Details:

Source cluster version

Constraints:

None

Options:

N/A

targetVersion

String

Details:

Current cluster version

Constraints:

None

Options:

Supported cluster versions

Table 7 status

Parameter

Type

Description

phase

String

Status. Options:

  • Success

  • Failed

  • Error

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"
  }
}

Status Codes

Status Code

Description

200

Cluster post-upgrade check succeeded.

Error Codes

See Error Codes.