DescribeEvents - Container Service for Kubernetes - Alibaba Cloud Documentation Center

Queries detailed information about a type of events, including the severity level, status, and start time of each event. Events are generated when clusters are created, modified, and updated, node pools are created and scaled out, and components are installed.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DescribeEvents	Read	All Resources *	none	none

Request syntax

GET /events

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	The cluster ID.	cf62854ac2130470897be7a27ed1f****
type	string	No	The event type. Valid values: `cluster_create`: cluster creation. `cluster_scaleout`: cluster scale-out. `cluster_attach`: node addition. `cluster_delete`: cluster deletion. `cluster_upgrade`: cluster upgrades. `cluster_migrate`: cluster migration. `cluster_node_delete`: node removal. `cluster_node_drain`: node draining. `cluster_modify`: cluster modifications. `cluster_configuration_modify`: modifications of control plane configurations. `cluster_addon_install`: component installation. `cluster_addon_upgrade`: component updates. `cluster_addon_uninstall`: component uninstallation. `runtime_upgrade`: runtime updates. `nodepool_upgrade`: node pool upgrades. `nodepool_update`: node pool updates.	nodepool_upgrade
page_size	long	No	The number of entries per page.	50
page_number	long	No	The page number.	1

Response parameters

Parameter	Type	Description	Example
	object	The response body.
events	object []	The details of the event.
event_id	string	The event ID.	A234-1234-1234
type	string	The event type. Valid values: `cluster_create`: cluster creation. `cluster_scaleout`: cluster scale-out. `cluster_attach`: node addition. `cluster_delete`: cluster deletion. `cluster_upgrade`: cluster upgrades. `cluster_migrate`: cluster migration. `cluster_node_delete`: node removal. `cluster_node_drain`: node draining. `cluster_modify`: cluster modifications. `cluster_configuration_modify`: modifications of control plane configurations. `cluster_addon_install`: component installation. `cluster_addon_upgrade`: component updates. `cluster_addon_uninstall`: component uninstallation. `runtime_upgrade`: runtime updates. `nodepool_upgrade`: node pool upgrades. `nodepool_update`: node pool updates.	nodepool_upgrade
source	string	The source of the event.	/clusters/cf62854ac2130470897be7a27ed1f****/nodepools
subject	string	The subject of the event.	nodePool-id
time	string	The time when the event started.	2022-11-23T20:48:01+08:00
cluster_id	string	The ID of the cluster.	cluster-id
data	object	The description of the event.
level	string	The severity level of the event.	info
reason	string	The status of the event.	Started
message	string	The details of the event.	Start to upgrade NodePool nodePool/nodePool-A
page_info	object	The pagination information.
page_size	long	The number of entries per page.	50
page_number	long	The page number.	1
total_count	long	The total number of entries returned.	3

Examples

Sample success responses

JSONformat

{
  "events": [
    {
      "event_id": "A234-1234-1234",
      "type": "nodepool_upgrade",
      "source": "/clusters/cf62854ac2130470897be7a27ed1f****/nodepools",
      "subject": "nodePool-id",
      "time": "2022-11-23T20:48:01+08:00",
      "cluster_id": "cluster-id",
      "data": {
        "level": "info",
        "reason": "Started",
        "message": "Start to upgrade NodePool nodePool/nodePool-A"
      }
    }
  ],
  "page_info": {
    "page_size": 50,
    "page_number": 1,
    "total_count": 3
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history