All Products
Search
Document Center

Container Service for Kubernetes:RunClusterCheck

Last Updated:Apr 22, 2024

You can call the RunClusterCheck operation to initiate cluster checks, such as cluster update prechecks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /clusters/[cluster_id]/checks

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringNo

The cluster ID.

ce0da5a1d627e4e9e9f96cae8ad07****
bodyobjectNo

The request body.

typestringYes

The check method.

ClusterUpgrade
optionsobjectNo

The cluster check items.

stringNo

The cluster check parameters.

next_version

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

request_idstring

Id of the request

F04DF81D-5C12-1524-B36A-86E02526****
check_idstring

The ID of the cluster check task.

1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto

Examples

Sample success responses

JSONformat

{
  "request_id": "F04DF81D-5C12-1524-B36A-86E02526****",
  "check_id": "1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-14The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-11-21The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.