Queries the full status information about one or more Elastic Block Storage (EBS) devices.
Operation description
- The full status information about an EBS device includes the lifecycle status specified by the
Statusparameter, health status specified by theHealthStatusparameter, and event type specified by theEventTypeparameter of the EBS device. You can filter the results based on these parameters. - The release time, scheduled execution time, and actual execution time of each EBS device event are identical. If you specify a period of time by using the
EventTime.StartandEventTime.Endparameters, all events that occurred within this period are queried. You can query events that occurred within the last seven days.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| ecs:DescribeDisksFullStatus | list | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}*Disk acs:ecs:{#regionId}:{#accountId}:disk/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the EBS device. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| Status | string | No | The lifecycle status of the EBS device. For more information, see Disk status. Valid values:
| Available |
| HealthStatus | string | No | The health status of the EBS device. Valid values:
| Warning |
| EventType | string | No | The event type of the EBS device. Valid values:
| Stalled |
| EventTime.Start | string | No | The beginning of the time range to query occurred events. Specify the time in the ISO 8601 standard in the | 2018-05-06T02:43:10Z |
| EventTime.End | string | No | The end of the time range to query occurred events. Specify the time in the ISO 8601 standard in the | 2018-05-08T02:48:52Z |
| PageNumber | integer | No | The page number. Pages start from page 1. The value must be a positive integer. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
| DiskId | array | No | The ID of EBS device N. Valid values of N: 1 to 100. | |
| string | No | The ID of EBS device N. Valid values of N: 1 to 100. | d-bp67acfmxazb4p**** | |
| EventId | array | No | The ID of event N. Valid values of N: 1 to 100. | |
| string | No | The ID of event N. Valid values of N: 1 to 100. | e-bp67acfmxazb4p**** | |
| ResourceGroupId | string | No | The ID of the resource group to which the EBS device belongs. If you configure this parameter to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. | rg-aek2kkmhmhs**** |
| Tag | array<object> | No | The tags to add to the EBS device. | |
| object | No | The tags to add to the EBS device. | ||
| Key | string | No | The key of tag N to add to the EBS device. A key-value pair consists of a key specified by the Tag.N.Key parameter and a value specified by the Up to 1,000 resources with the specified tags can be returned in the response. | TestKey |
| Value | string | No | The value of tag N to add to the EBS device. A key-value pair consists of a key specified by the | TestValue |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 2,
"DiskFullStatusSet": {
"DiskFullStatusType": [
{
"DiskId": "d-bp67acfmxazb4p****",
"InstanceId": "i-bp67acfmxazb4p****",
"Device": "null",
"DiskEventSet": {
"DiskEventType": [
{
"EventId": "e-bp67acfmxazb4p****",
"EventEndTime": "2018-05-06T02:48:52Z",
"EventTime": "2018-05-08T02:43:10Z",
"ImpactLevel": "100",
"EventType": {
"Name": "Stalled",
"Code": 7
}
}
]
},
"Status": {
"Name": "Available",
"Code": 129
},
"HealthStatus": {
"Name": "Impaired",
"Code": 128
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | InvalidParameter | %s | The specified parameter is invalid. |
| 403 | DiskIdLimitExceeded | %s | More than 100 disk IDs are specified. |
| 403 | EventIdLimitExceeded | %s | More than 100 simulated event IDs are specified. |
| 403 | InvalidParameter.TimeEndBeforeStart | %s | The specified parameter is invalid. Make sure that the end time is later than the start time. |
| 403 | OperationDenied.NotInWhiteList | %s | You are not authorized to perform this operation. Try again when you are authorized. |
| 403 | TooManyDiskEvent.DiskIdRequired | %s | The system cannot process this number of requests for the specified resource. Try again later. |
| 404 | MissingParameter | %s | A parameter is not specified. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-03 | API Description Update. The Error code has changed | View Change Details |