DescribeResourceUsageTotal-阿里云帮助中心

Queries the usage summary 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:DescribeResourceUsageTotal

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 data at this time. This value specifies the start time of the query range.	2021-01-01 00:00:00
EndPeriod	string	No	The end time. Format: yyyy-MM-dd HH:mm:ss. The query excludes data at this time. If this parameter is left empty, the query range extends to the current time. This value specifies the end time of the query range.	2021-01-02 00:00:00
PeriodType	string	Yes	The time granularity. Valid values: MONTH: month DAY: day HOUR: hour Valid values: MONTH : MONTH HOUR : HOUR DAY : DAY	HOUR
BillOwnerId	integer	No	The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource. Only one account ID can be specified.	123745698925000
ResourceType	string	Yes	The resource plan type. Valid values: RI: reserved instance. SCU: storage capacity unit. Valid values: SCU : SCU RI : RI	RI

Response elements

Element	Type	Description	Example
	object	The root node.
Code	string	The status code.	Success
Data	object	The data.
PeriodCoverage	array<object>	The usage by period.
	object	The usage by period.
Period	string	The period.	2021071500
UsagePercentage	number	The usage percentage.	0.1
TotalUsage	object	The total usage.
PostpaidCost	number	The total cost of pay-as-you-go instances.	200
PotentialSavedCost	number	The potential total savings.	100
ReservationCost	number	The total resource purchase cost.	10
SavedCost	number	The total savings.	100
UsagePercentage	number	The total usage.	1
Message	string	The error message.	Successful!
RequestId	string	The request ID.	364C7C81-5E5E-51A0-B738-1969D2671B05
Success	boolean	Indicates whether the request was successful.	True

Examples

Success response

JSON format

{
  "Code": "Success",
  "Data": {
    "PeriodCoverage": [
      {
        "Period": "2021071500",
        "UsagePercentage": 0.1
      }
    ],
    "TotalUsage": {
      "PostpaidCost": 200,
      "PotentialSavedCost": 100,
      "ReservationCost": 10,
      "SavedCost": 100,
      "UsagePercentage": 1
    }
  },
  "Message": "Successful!",
  "RequestId": "364C7C81-5E5E-51A0-B738-1969D2671B05",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.