Use QueryDedicatedBlockStorageClusterInventoryData to query capacity trend data - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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. Valid values: 60 : 60 3600 : 3600 86400 : 86400	60
StartTime	integer	Yes	Start timestamp of trend data.	1606303800
EndTime	integer	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 elements

Element	Type	Description	Example
	object	DescribeDbscInventoryDataResponse
DbscId	string	The ID of the dedicated block storage cluster.	dbsc-xxx
DbscName	string	The name of the dedicated block storage cluster.	myDBSCCluster
DiskCategory	string	The type of the disk. Valid values: cloud_essd: enhanced SSD (ESSD).	cloud_essd
TotalCount	integer	The total number of entries returned.	60
Data	array<object>	The returned data.
	array<object>	The information about the array object.
MonitorItems	object	The returned metrics.
AvailableSize	integer	Available capacity size of the dedicated block storage cluster.	61360
TotalSize	integer	Total capacity size of the dedicated block storage cluster.	61440
Timestamp	string	The timestamp when the data is collected.	1606403800
ResourceId	string	The ID list of the resource.	dbsc-xxx
RequestId	string	The ID of the request.	F1A4258A-0C8C-5329-B495-BC5AD7AD****

Examples

Success response

JSON format

{
  "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.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
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.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.