DescribeClusterEvents-阿里云帮助中心

Queries the operation events of a specified cluster, including cluster creation, cluster modification, node pool creation, node pool scale-out, add-on installation, and cluster upgrade. You can call the DescribeClusterEvents operation to obtain the list of events that occurred in the specified cluster and query the event details, such as the event level, event status, and event time.

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

get

*Cluster

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

None

Request syntax

GET /clusters/{ClusterId}/events HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c82e6987e2961451182edacd74faf****

Request parameters

Parameter	Type	Required	Description	Example
page_size	integer	No	The maximum number of results to display on each page. Valid values: 1 to 100. Default value: 50.	50
page_number	integer	No	The page number.	1
next_token	string	No	The pagination token. Set the value to the next_token value returned from the previous API call.
max_results	integer	No	The maximum number of results to return for a single request.
task_id	string	No	The ID of the task to query.	T-6823f946ffadbb0106****

Response elements

Element	Type	Description	Example
	object	The response parameters.
events	array<object>	The list of events.
	array<object>
event_id	string	The event ID.	e-9ad04f72-8ee7-46bf-a02c-e4a06b39****
type	string	The event type. Valid values: cluster_create: cluster creation cluster_scaleout: cluster scale-out cluster_attach: addition of existing nodes cluster_delete: cluster deletion cluster_upgrade: cluster upgrade cluster_migrate: cluster migration cluster_node_delete: node removal cluster_node_drain: node draining cluster_modify: cluster modification cluster_configuration_modify: cluster control configuration modification cluster_addon_install: add-on installation cluster_addon_upgrade: add-on upgrade cluster_addon_uninstall: add-on uninstallation runtime_upgrade: runtime upgrade nodepool_upgrade: node pool upgrade nodepool_update: node pool update	nodepool_update
source	string	The event source.	task
subject	string	The operation object associated with the event.	npdd89dc2b76c04f14b06774883b******
time	string	The start time of the event in ISO 8601 format, including time zone information.	2025-05-14T10:00:56+08:00
cluster_id	string	The cluster ID.	c82e6987e2961451182edacd74faf****
data	object	The event description.
level	string	The event level. Valid values: warning : warning error : error info : info	info
reason	string	The event status.	Started
message	string	The event details.	Start to upgrade NodePool nodePool/npdd89dc2b76c04f14b06774883b******
next_token	string	The pagination token.
page_info	object	The pagination information.
page_size	integer	The maximum number of results to display on each page.	50
page_number	integer	The page number.	1
total_count	integer	The total number of results.	126

Examples

Success response

JSON format

{
  "events": [
    {
      "event_id": "e-9ad04f72-8ee7-46bf-a02c-e4a06b39****",
      "type": "nodepool_update",
      "source": "task",
      "subject": "npdd89dc2b76c04f14b06774883b******",
      "time": "2025-05-14T10:00:56+08:00",
      "cluster_id": "c82e6987e2961451182edacd74faf****",
      "data": {
        "level": "info",
        "reason": "Started",
        "message": "Start to upgrade NodePool nodePool/npdd89dc2b76c04f14b06774883b******"
      }
    }
  ],
  "next_token": "",
  "page_info": {
    "page_size": 50,
    "page_number": 1,
    "total_count": 126
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.