Call the RunClusterCheck API to initiate cluster checks - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Container Intelligence Service (CIS) provides a variety of cluster check capabilities to allow you to perform cluster update check, cluster migration check, component installation check, component update check, and node pool check. A precheck is automatically triggered before an update, migration, or installation is performed. You can perform changes only if the cluster passes the precheck. You can also manually call the RunClusterCheck operation to initiate cluster checks. We recommend that you periodically check and maintain your cluster to mitigate potential risks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:RunClusterCheck

none

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

POST /clusters/{cluster_id}/checks HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	The cluster ID.	ce0da5a1d627e4e9e9f96cae8ad******

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
type	string	Yes	The check type. Valid values: ClusterMigrate: cluster migration. MasterUpgrade: control plane upgrade. NodePoolUpgrade: node pool upgrade. ClusterUpgrade: cluster upgrade. Valid values: ClusterMigrate : cluster migration MasterUpgrade : control plane upgrade NodePoolUpgrade : node pool upgrade ClusterUpgrade : cluster upgrade	NodePoolUpgrade
target	string	No	The check target. If you set `type=NodePoolUpgrade`, you must set this parameter to the node pool ID. Otherwise, this parameter is optional.	np1f6779297c4444a3a1cdd29be8******
options	object	No	The cluster check parameters.
	string	No	A cluster check parameter.	next_version:1.32.1-aliyun.1

Response elements

Element	Type	Description	Example
	object	Schema of Response
request_id	string	The ID of the request.	F04DF81D-5C12-1524-B36A-86E025******
check_id	string	The ID of the cluster check task.	1697100584236****-ce0da5a1d627e4e9e9f96cae8ad****-clustercheck-lboto

Examples

Success response

JSON format

{
  "request_id": "F04DF81D-5C12-1524-B36A-86E025******",
  "check_id": "1697100584236******-ce0da5a1d627e4e9e9f96cae8ad******-clustercheck-lboto"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.