Updated on 2024-04-23 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.

URI

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

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

apiVersion

Yes

String

API version, which defaults to v3

kind

Yes

String

Resource type

spec

Yes

PostcheckSpec object

spec indicates the configuration confirmed after an upgrade.

Table 3 PostcheckSpec

Parameter

Mandatory

Type

Description

clusterID

No

String

Cluster ID

clusterVersion

No

String

Source cluster version

targetVersion

No

String

Target 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

Cluster ID

clusterVersion

String

Source cluster version

targetVersion

String

Target cluster version

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.