QueryDedicatedBlockStorageClusterInventoryData - Elastic Compute Service

Queries the trends of the available capacity and total capacity of a dedicated block storage cluster within a specific time range.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: 60. 3600: 3600. 86400: 86400.	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

Parameter	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.
	object	The information about the array object.
MonitorItems	object	The returned metrics.
AvailableSize	long	Available capacity size of the dedicated block storage cluster.	61360
TotalSize	long	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

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

No change history