DescribeEvents - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the risk events of a disk.

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.

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
ebs:DescribeEvents	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID . You can call the DescribeRegions operation to query the most recent list of regions supported.	cn-hangzhou
EventName	string	No	The name of the event. Valid values: NoSnapshot: indicates the event that is triggered because no snapshot is created for a disk to protect data on the disk. BurstIOTriggered: indicates the event that is triggered when a burst I/O operation is performed on a disk. CostOptimizationNeeded: indicates the event that is triggered when cost optimization is required. DiskSpecNotMatchedWithInstance: indicates the event that is triggered because the specifications of a disk do not match the instance to which the disk is attached. DiskIONo4kAligned: indicates the event that is triggered because the physical and logical sectors involved in a read or write operation are not 4K aligned. DiskIOHang: indicates the event that is triggered when an I/O hang occurs on a disk. InstanceIOPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of IOPS on an instance reaches the upper limit. InstanceBPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of BPS on an instance reaches the upper limit. DiskIOPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of IOPS on a disk reaches the upper limit for the associated instance. DiskBPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of BPS on a disk reaches the upper limit for the associated instance. DiskIOPSExceedDiskMaxLimit: indicates the event that is triggered when the number of IOPS on a disk reaches the upper limit for the disk. DiskBPSExceedDiskMaxLimit: indicates the event that is triggered when the number of BPS on a disk reaches the upper limit for the disk.	DiskIOHang
ResourceId	string	No	The resource ID.	d-bp67acfmxazb4p****
ResourceType	string	No	The type of resource. Valid values: disk. Default value: disk.	disk
Status	string	No	The status of event. Valid values: WillExecute Executing Executed Ignore Expired Deleted	WillExecute
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-06-01T03:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-06-01T04:00:00Z
MaxResults	integer	No	The maximum number of entries per page. If you specify MaxResults, `MaxResults` and `NextToken` are used for a paged query. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results.	AAAAAdDWBF2****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	The total number of entries returned.	1
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	AAAAAdDWBF2****
ResourceEvents	array<object>	The events.
resourceEvent	object
EventType	string	The type of the event. Valid values: Notification SystemException Alert	Alert
EventName	string	The name of the event. Valid values: NoSnapshot: indicates the event that is triggered because no snapshot is created for a disk to protect data on the disk. BurstIOTriggered: indicates the event that is triggered when a burst I/O operation is performed on a disk. CostOptimizationNeeded: indicates the event that is triggered when cost optimization is required. DiskSpecNotMatchedWithInstance: indicates the event that is triggered because the specifications of a disk do not match the instance to which the disk is attached. DiskIONo4kAligned: indicates the event that is triggered because the physical and logical sectors involved in a read or write operation are not 4K aligned. DiskIOHang: indicates the event that is triggered when an I/O hang occurs on a disk. InstanceIOPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of IOPS on an instance reaches the upper limit. InstanceBPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of BPS on an instance reaches the upper limit. DiskIOPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of IOPS on a disk reaches the upper limit for the associated instance. DiskBPSExceedInstanceMaxLimit: indicates the event that is triggered when the number of BPS on a disk reaches the upper limit for the associated instance. DiskIOPSExceedDiskMaxLimit: indicates the event that is triggered when the number of IOPS on a disk reaches the upper limit for the disk. DiskBPSExceedDiskMaxLimit: indicates the event that is triggered when the number of BPS on a disk reaches the upper limit for the disk.	DiskIOHang
ResourceId	string	The ID of the resource.	d-bp67acfmxazb4p****
ResourceType	string	The type of the resource.	disk
Status	string	The status of the event. Valid values: WillExecute Executing Executed Ignore Expired Deleted	WillExecute
StartTime	string	The start time of the event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.	1684204822000
Description	string	The description of the event.	need snapshot
RecommendAction	string	The recommended action after the event occurred. Valid values: ModifyDiskSpec CreateSnapshot ResizeDisk AdjustProvision ModifyInstanceSpec	AdjustProvision
RecommendParams	string	The codes of the parameters for the recommended action after the event occurred.	4296
EventLevel	string	The level of the event. Valid values: INFO WARN CRITICAL	INFO
EndTime	string	The end time of the event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.	1679538083000

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2****",
  "ResourceEvents": [
    {
      "EventType": "Alert",
      "EventName": "DiskIOHang",
      "ResourceId": "d-bp67acfmxazb4p****\n",
      "ResourceType": "disk",
      "Status": "WillExecute",
      "StartTime": "1684204822000",
      "Description": "need snapshot",
      "RecommendAction": "AdjustProvision",
      "RecommendParams": "4296",
      "EventLevel": "INFO",
      "EndTime": "1679538083000"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

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

Change history

Change time	Summary of changes	Operation
2024-08-19	The Error code has changed	View Change Details