Queries the usage details of reserved instances (RIs) or storage capacity units (SCUs).
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 |
|---|---|---|---|---|
| bssapi:DescribeResourceUsageDetail | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| StartPeriod | string | Yes | The beginning of the time range to query. The beginning is included in the time range. Specify the time in the yyyy-MM-dd HH:mm:ss format. | 2021-01-01 00:00:00 |
| EndPeriod | string | No | The end of the time range to query. The end is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss. | 2021-01-02 00:00:00 |
| PeriodType | string | Yes | The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR. | HOUR |
| NextToken | string | No | The pagination token that is used in the next 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. If NextToken is empty, no next page exists. | eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9 |
| MaxResults | integer | No | The maximum number of entries to return. Default value: 20. The maximum value is 300. | 200 |
| BillOwnerId | long | No | The ID of the account whose data you want to query. If you do not specify this parameter, the data of the current Alibaba Cloud account and its Resource Access Management (RAM) users is queried. To query the data of a RAM user, specify the ID of the RAM user. | 123745698925000 |
| ResourceType | string | Yes | The type of deduction plan whose usage details are queried. Valid values: RI and SCU. | RI |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "Success",
"Message": "Successful!",
"RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
"Success": true,
"Data": {
"NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
"TotalCount": 10000,
"MaxResults": 200,
"Items": [
{
"Status": "Valid",
"UsagePercentage": 0.5,
"ResourceInstanceId": "ecsri-bp147nnfz21225k9mpix00",
"TotalQuantity": 2,
"ReservationCost": "0",
"RegionNo": "cn-hangzhou-dg-a01",
"UserId": "123745698925000",
"StatusName": "",
"CapacityUnit": "",
"PotentialSavedCost": "0.13",
"Currency": "CNY",
"ZoneName": "",
"InstanceSpec": "ecs.t5-lc2m1.nano",
"EndTime": "2021-04-01 01:00:00",
"PostpaidCost": "0.06",
"ImageType": "linux",
"StartTime": "2021-04-01 00:00:00",
"Region": "",
"DeductQuantity": 1,
"SavedCost": "0.06",
"Zone": "cn-hangzhou-i",
"UserName": "test@aliyun.com",
"Quantity": 2
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.