DescribeResourceUsageDetail-阿里云帮助中心

Queries the usage details of reserved instances and Storage Capacity Units (SCUs).

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

bssapi:DescribeResourceUsageDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartPeriod	string	Yes	The start time. Format: yyyy-MM-dd HH:mm:ss. The query includes this time.	2021-01-01 00:00:00
EndPeriod	string	No	The end time. Format: yyyy-MM-dd HH:mm:ss. The query excludes this time. If this parameter is left empty, the query covers data up to the current time.	2021-01-02 00:00:00
PeriodType	string	Yes	The time granularity. Valid values: MONTH: month DAY: day HOUR: hour	HOUR
NextToken	string	No	The pagination token. Leave this parameter empty for the first page. The response includes a token for the next page. If the returned token is empty, all data has been retrieved.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
MaxResults	integer	No	The maximum number of data records to return. Default value: 20. Maximum value: 300.	200
BillOwnerId	integer	No	The account ID. If this parameter is left empty, data of the current account and its trusteeship linked accounts is queried. You can specify a trusteeship linked account ID to query data of that account.	123745698925000
ResourceType	string	Yes	The resource plan type. Valid values: RI: reserved instance. SCU: Storage Capacity Unit (SCU).	RI

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Data	object	The returned data.
Items	array<object>	The data entries.
	object
CapacityUnit	string	The offset unit.	Computing power*hours
Currency	string	The currency.	CNY
DeductQuantity	number	The offset quantity.	1
EndTime	string	The end time.	2021-04-01 01:00:00
ImageType	string	The operating system.	linux
InstanceSpec	string	The instance type.	ecs.t5-lc2m1.nano
PostpaidCost	string	The equivalent pay-as-you-go cost.	0.06
PotentialSavedCost	string	The potential net savings.	0.13
Quantity	integer	The resource count.	2
Region	string	The region.	China (Hangzhou)
RegionNo	string	The region code.	cn-hangzhou-dg-a01
ReservationCost	string	The purchase cost of the resource.	0
ResourceInstanceId	string	The resource instance ID.	ecsri-bp147nnfz21225k9mpix00
SavedCost	string	The net savings.	0.06
StartTime	string	The start time.	2021-04-01 00:00:00
Status	string	The status.	Valid
StatusName	string	The status name.	Active
TotalQuantity	number	The total resource quantity.	2
UsagePercentage	number	The usage percentage.	0.5
UserId	string	The account ID.	123745698925000
UserName	string	The account name.	test@aliyun.com
Zone	string	The zone.	cn-hangzhou-i
ZoneName	string	The zone code.	Hangzhou Zone I
MaxResults	integer	The maximum number of data records returned. Default value: 20. Maximum value: 300.	200
NextToken	string	The token for the next page.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
TotalCount	integer	The total number of entries.	10000
Message	string	The error message.	Successful!
RequestId	string	The request ID.	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Code": "Success",
  "Data": {
    "Items": [
      {
        "CapacityUnit": "算力*小时",
        "Currency": "CNY",
        "DeductQuantity": 1,
        "EndTime": "2021-04-01 01:00:00",
        "ImageType": "linux",
        "InstanceSpec": "ecs.t5-lc2m1.nano",
        "PostpaidCost": "0.06",
        "PotentialSavedCost": "0.13",
        "Quantity": 2,
        "Region": "华东1（杭州）",
        "RegionNo": "cn-hangzhou-dg-a01",
        "ReservationCost": "0",
        "ResourceInstanceId": "ecsri-bp147nnfz21225k9mpix00",
        "SavedCost": "0.06",
        "StartTime": "2021-04-01 00:00:00",
        "Status": "Valid",
        "StatusName": "生效",
        "TotalQuantity": 2,
        "UsagePercentage": 0.5,
        "UserId": "123745698925000",
        "UserName": "test@aliyun.com",
        "Zone": "cn-hangzhou-i",
        "ZoneName": "杭州 可用区I"
      }
    ],
    "MaxResults": 200,
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
    "TotalCount": 10000
  },
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.