All Products
Search
Document Center

Container Service for Kubernetes:DescribeEvents

Last Updated:Nov 07, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeEventsget
  • All Resources
    *
    none
none

Request syntax

GET /events HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringNo

The cluster ID.

cf62854ac2130470897be7a27ed1f****
typestringNo

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_sizelongNo

The number of entries per page.

50
page_numberlongNo

The page number.

1

Response parameters

ParameterTypeDescriptionExample
object

The response body.

eventsarray<object>

The details of the events.

eventobject

The details of the event.

event_idstring

The event ID.

A234-1234-1234
typestring

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
sourcestring

The source of the event.

/clusters/cf62854ac2130470897be7a27ed1f****/nodepools
subjectstring

The subject of the event.

nodePool-id
timestring

The time when the event started.

2022-11-23T20:48:01+08:00
cluster_idstring

The ID of the cluster.

cluster-id
dataobject

The description of the event.

levelstring

The severity level of the event. Valid values:

  • info
  • warning
  • error
info
reasonstring

The status of the event.

Started
messagestring

The details of the event.

Start to upgrade NodePool nodePool/nodePool-A
page_infoobject

The pagination information.

page_sizelong

The number of entries per page.

50
page_numberlong

The page number.

1
total_countlong

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 timeSummary of changesOperation
No change history