DescribeDiskEvents - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the risk events of a disk.

Operation description

Usage notes

CloudLens for EBS is in invitational preview in the China (Hangzhou), China (Shanghai), China (Zhangjiakou), China (Shenzhen), and China (Hong Kong) regions. To use the feature, submit a ticket.

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:DescribeDiskEvents	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the disk. You can call the DescribeRegions operation to query the list of regions that support CloudLens for EBS.	cn-hangzhou
DiskCategory	string	No	The type of the disk. Valid values: cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud_essd: enhanced SSD (ESSD).	cloud_essd
Type	string	No	The event type. Set the value to DataNeedProtect, which indicates that the disk data needs to be protected.	DataNeedProtect
DiskId	string	No	The ID of the disk.	d-bp67acfmxazb4p****
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.	2022-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.	2022-06-01T05:00:00Z
MaxResults	long	No	The maximum number of entries per page. Valid values: 1 to 100. Default values: If this parameter is not specified or is set to a value smaller than 10, the default value is 10. If this parameter is set to a value greater than 100, the default value is 100.	10
NextToken	string	No	The pagination token that is used in this request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.	caeba0bbb2be03f84eb48b699f0a****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	long	The total number of entries returned.	20
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0a****
DiskEvents	array<object>	The risk events of the disk.
DiskEvent	object	The risk event of the disk.
Type	string	The type of the event. Only DataNeedProtect can be returned.	DataNeedProtect
DiskId	string	The ID of the disk.	d-bp1bq5g3dxxo1x4o****
Status	string	The state of the event. Valid values: Solved UnSolved	Solved
Timestamp	string	The time when the event occurred. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-06-01T08:00:00Z
Description	string	The description of the event.	This is description.
RecommendAction	string	The recommended action after the event occurred. Valid values: Resize: resizes the disk. ModifyDiskSpec: changes the category of the disk. NoAction: performs no operation.	NoAction
RegionId	string	The region ID of the disk.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 20,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "DiskEvents": [
    {
      "Type": "DataNeedProtect",
      "DiskId": "d-bp1bq5g3dxxo1x4o****",
      "Status": "Solved",
      "Timestamp": "2022-06-01T08:00:00Z",
      "Description": "This is description.",
      "RecommendAction": "NoAction",
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
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
2023-03-22	The Error code has changed	View Change Details