Queries the capacity trend data of a dedicated Elastic Block Storage (EBS) cluster within a specific time period, including the available capacity and total capacity.
Operation description
Period is the time interval between data retrieval points. When set to 60 (minute interval), a maximum of 1440 data points can be returned; when set to 3600 (hour interval), a maximum of 744 data points can be returned; and when set to 86400 (day interval), a maximum of 366 data points can be returned.
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 |
|---|---|---|---|---|
| ebs:QueryDedicatedBlockStorageClusterInventoryData | get | *DedicatedBlockStorageCluster acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DbscId | string | Yes | The ID of the dedicated block storage cluster. | dbsc-xxx |
| Period | integer | Yes | The time interval (seconds) between data retrieval points. Enumeration Value:
| 60 |
| StartTime | long | Yes | Start timestamp of trend data. | 1606303800 |
| EndTime | long | Yes | End timestamp of trend data. | 1606403800 |
| RegionId | string | Yes | The region ID of the dedicated block storage cluster. | cn-shenzhen |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure idempotence . | 123e4567-e89b-12d3-a456-42665544**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"DbscId": "dbsc-xxx",
"DbscName": "myDBSCCluster",
"DiskCategory": "cloud_essd",
"TotalCount": 60,
"Data": [
{
"MonitorItems": {
"AvailableSize": 61360,
"TotalSize": 61440
},
"Timestamp": "1606403800",
"ResourceId": "dbsc-xxx"
}
],
"RequestId": "F1A4258A-0C8C-5329-B495-BC5AD7AD****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidTime.Malformed | The specified parameter StartTime or EndTime is not valid. | - |
| 400 | InvalidParameter.EndTime | The specified parameter EndTime is earlier than StartTime. | - |
| 400 | InvalidPeriod.ValueNotSupported | The specified parameter Period is not valid | - |
| 400 | InvalidParameter.TooManyDataQueried | Too many data queried. | - |
| 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 |
|---|