Use DescribeClusterTasks to query cluster tasks - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the tasks in a specified cluster.

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:DescribeClusterTasks

get

*Cluster

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

None

Request syntax

GET /clusters/{cluster_id}/tasks HTTP/1.1

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
page_size	integer	No	The number of tasks to return on each page.	20
page_number	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	The response body.
page_info	object	The pagination details.
page_size	integer	The number of tasks returned on the current page.	10
page_number	integer	The current page number.	1
total_count	integer	The total number of tasks.	10
next_token	string
tasks	array<object>	A list of tasks.
	array<object>	The task details.
task_id	string	The task ID.	install-addons-c3xxxxxx
task_type	string	The task type.	cluster_addon_install
state	string	The task status.	success
created	string	The creation time.	2022-08-03T10:11:33+08:00
updated	string	The update time.	2022-08-03T10:12:03.482+08:00
error	object	Details about the error if the task failed.
message	string	The error message.	Addon status not match
code	string	The error code.	BadRequest
requestId	string	The request ID.	0527ac9a-c899-4341-a21a-xxxxxxxxx

Examples

Success response

JSON format

{
  "page_info": {
    "page_size": 10,
    "page_number": 1,
    "total_count": 10
  },
  "next_token": "",
  "tasks": [
    {
      "task_id": "install-addons-c3xxxxxx",
      "task_type": "cluster_addon_install",
      "state": "success",
      "created": "2022-08-03T10:11:33+08:00",
      "updated": "2022-08-03T10:12:03.482+08:00",
      "error": {
        "message": "Addon status not match",
        "code": "BadRequest"
      }
    }
  ],
  "requestId": "0527ac9a-c899-4341-a21a-xxxxxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.