ListClusterChecks - Container Service for Kubernetes - Alibaba Cloud Documentation Center

You can call the ListClusterChecks operation to query all the cluster check results of a cluster.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /clusters/[cluster_id]/checks

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	The cluster ID.	ce0da5a1d627e4e9e9f96cae8ad07****
type	string	No	The check method.	ClusterUpgrade
target	string	No	The targets to check.

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
checks	object []	The list of check items.
check_id	string	The ID of the cluster check task.	1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto
type	string	The check method.	ClusterUpgrade
status	string	The status of the cluster check.	Succeeded
message	string	The message that indicates the status of the cluster check task.	task succeed
created_at	string	The time when the cluster check task was created.	2023-10-16T08:31:20.292030178Z
finished_at	string	The time when the cluster check task was completed.	2023-10-16T08:35:20.292030178Z

Examples

Sample success responses

JSONformat

{
  "checks": [
    {
      "check_id": "1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto",
      "type": "ClusterUpgrade",
      "status": "Succeeded",
      "message": "task succeed",
      "created_at": "2023-10-16T08:31:20.292030178Z",
      "finished_at": "2023-10-16T08:35:20.292030178Z"
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-03-14

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: target

2023-11-21

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.