DocsICP FilingConsole
官方文档
首页

DescribeClusterEvents

更新时间：
复制 MD 格式
产品详情
我的收藏

Call the DescribeClusterEvents operation to retrieve events that occurred in a specified cluster. These events include cluster creation, cluster modification, node pool creation, node pool scaling, addon installation, and cluster upgrades. You can query the details for each event, such as the event level, status, and time of occurrence.

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 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 number of entries to return per page.

Valid values: 1 to 100.

Default value: 50.

50
page_number

integer

No

The page number.

1
task_id

string

No

The task ID. If you specify a task ID, all events for the task are queried.

T-6823f946ffadbb0106****

Response elements

Element

Type

Description

Example

object

The response body.

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: create a cluster.

  • cluster_scaleout: scale out a cluster.

  • cluster_attach: add existing nodes to a cluster.

  • 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 configurations of a cluster.

  • cluster_addon_install: install an addon.

  • cluster_addon_upgrade: upgrade an addon.

  • cluster_addon_uninstall: uninstall an addon.

  • runtime_upgrade: upgrade the runtime.

  • nodepool_upgrade: upgrade a node pool.

  • nodepool_update: update a node pool.

nodepool_update
source

string

The source of the event.

task
subject

string

The resource that is the subject of the event.

npdd89dc2b76c04f14b06774883b******
time

string

The start time of the event.

2025-05-14T10:00:56+08:00
cluster_id

string

The cluster ID.

c82e6987e2961451182edacd74faf****
data

object

The event data.

level

string

The event level.

Valid values:

  • warning :

    A potential issue.

  • error :

    An error that may have caused the associated task to fail.

  • info :

    An informational event.

info
reason

string

The event status.

Started
message

string

The event details.

Start to upgrade NodePool nodePool/npdd89dc2b76c04f14b06774883b******
next_token

string

The pagination token to use to retrieve the next page of results. If this parameter is not returned, it indicates that no more results are available.

page_info

object

The pagination information.

page_size

integer

The number of entries returned per page.

50
page_number

integer

The current page number.

1
total_count

integer

The total number of entries that match the query.

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.