GetClusterCheck - Container Service for Kubernetes - Alibaba Cloud Documentation Center

Queries a cluster check task by cluster ID and task ID. You can view the status, check items, creation time, and end time of the task. Container Intelligence Service (CIS) provides a variety of Kubernetes cluster check features, including cluster update check, cluster migration check, component installation check, component update check, and node pool check.

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/[check_id]

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	Yes	The cluster ID.	ce0da5a1d627e4e9e9f96cae8ad07****
check_id	string	Yes	The ID of the cluster check task.	1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
check_id	string	Id of the request	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
check_items	object	The list of check items.
	object []	The name of the check item.
	object	The properties of the check item.	Name

Examples

Sample success responses

JSONformat

{
  "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",
  "check_items": {
    "key": [
      {
        "test": "test",
        "test2": 1
      }
    ]
  }
}

Error codes

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

Change history

Change time

Summary of changes

Operation

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.