All Products
Search

This Product

    Container Service for Kubernetes:DescribeEvents

    Document Center

    Container Service for Kubernetes:DescribeEvents

    Last Updated:May 14, 2026

    Cluster operational events include cluster creation, cluster modification, node pool creation, node pool scale-out, addon installation, and cluster upgrades. Call the DescribeEvents API to query details about specific event types, including their level, status, and 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:DescribeEvents

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /events HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    cluster_id

    string

    No

    The cluster ID.

    cf62854ac2130470897be7a27ed1f****
    type

    string

    No

    The event type. Omit this parameter to return events of all types. Valid values:

    • cluster_create: Create a cluster.

    • cluster_scaleout: Scale out a cluster.

    • cluster_attach: Add an existing node.

    • cluster_delete: Delete a cluster.

    • cluster_upgrade: Upgrade a cluster.

    • cluster_migrate: Migrate a cluster.

    • cluster_node_delete: Remove a node.

    • cluster_node_drain: Drain a node.

    • cluster_modify: Modify a cluster.

    • cluster_configuration_modify: Modify the control plane configuration of a cluster.

    • cluster_addon_install: Install an add-on.

    • cluster_addon_upgrade: Upgrade an add-on.

    • cluster_addon_uninstall: Uninstall an add-on.

    • runtime_upgrade: Upgrade the runtime.

    • nodepool_upgrade: Upgrade a node pool.

    • nodepool_update: Update a node pool.

    nodepool_upgrade
    page_size

    integer

    No

    The number of results to return 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 token for the next page of results. To retrieve the next page, pass the NextToken value from the response to your previous request.

    5c0a1c0f91c14c6****
    max_results

    integer

    No

    The maximum number of results to return.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    events

    array<object>

    The list of events.

    array<object>

    An event.

    event_id

    string

    The event ID.

    e-dba703c8-953b-40d8-82e8-cb713590****
    type

    string

    The event type. Valid values:

    • cluster_create: Creates a cluster.

    • cluster_scaleout: Scales out a cluster.

    • cluster_attach: Adds an existing node.

    • cluster_delete: Deletes a cluster.

    • cluster_upgrade: Upgrades a cluster.

    • cluster_migrate: Migrates a cluster.

    • cluster_node_delete: Removes a node.

    • cluster_node_drain: Drains a node.

    • cluster_modify: Modifies a cluster.

    • cluster_configuration_modify: Modifies the control plane configuration of a cluster.

    • cluster_addon_install: Installs an add-on.

    • cluster_addon_upgrade: Upgrades an add-on.

    • cluster_addon_uninstall: Uninstalls an add-on.

    • runtime_upgrade: Upgrades the runtime.

    • nodepool_upgrade: Upgrades a node pool.

    • nodepool_update: Updates a node pool.

    nodepool_upgrade
    source

    string

    The event source.

    task
    subject

    string

    The event subject.

    np6a5c86f4ecae436f8f4a3dc034a7****
    time

    string

    The start time of the event.

    2025-04-23T20:48:01+08:00
    cluster_id

    string

    The cluster ID.

    cf62854ac2130470897be7a27ed1f****
    data

    object

    The event data.

    level

    string

    The event level. Valid values:

    • info: An informational event.

    • warning: A warning event.

    • error: An error event.

    info
    reason

    string

    The event reason.

    Started
    message

    string

    A detailed message about the event.

    Start to upgrade NodePool nodePool/nodePool-A
    next_token

    string

    The token to retrieve the next page of results.

    5c0a1c0f91c14c6****
    page_info

    object

    The pagination information.

    page_size

    integer

    The number of entries returned per page.

    50
    page_number

    integer

    The page number.

    1
    total_count

    integer

    The total number of results.

    3

    Examples

    Success response

    JSON format

    {
  "events": [
    {
      "event_id": "e-dba703c8-953b-40d8-82e8-cb713590****",
      "type": "nodepool_upgrade",
      "source": "task",
      "subject": "np6a5c86f4ecae436f8f4a3dc034a7****",
      "time": "2025-04-23T20:48:01+08:00",
      "cluster_id": "cf62854ac2130470897be7a27ed1f****",
      "data": {
        "level": "info",
        "reason": "Started",
        "message": "Start to upgrade NodePool nodePool/nodePool-A"
      }
    }
  ],
  "next_token": "5c0a1c0f91c14c6****",
  "page_info": {
    "page_size": 50,
    "page_number": 1,
    "total_count": 3
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.