DescribeSavingsPlansUsageTotal-阿里云帮助中心

Queries the savings plan usage summary.

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

bss:SavingsPlansAnalysis

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartPeriod	string	Yes	The start time of the time range to query. The start time 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 time of the time range to query. The end time is not included in the time range. If you do not specify this parameter, the end time is the current time. Specify the time in the yyyy-MM-dd HH:mm:ss format.	2021-01-02 00:00:00
PeriodType	string	Yes	The time granularity for querying the usage summary. Valid values: MONTH, DAY, and HOUR.	HOUR
BillOwnerId	integer	No	The ID of the account with resource ownership, which is the account that actually uses the resources.	123745698925000
FilterParam	object	No	The filter parameters.
Dimensions	array<object>	No	The list of dimension filter conditions.
	object	No	The dimension filter condition.
Code	string	No	The dimension code.
SelectType	string	No	The selection method for dimension filtering.
Values	array	No	The list of dimension filter values.
	string	No	The dimension filter value.
Tags	array<object>	No	The list of tag filter conditions.
	object	No	The tag filter condition.
Code	string	No	The tag code.
SelectType	string	No	The selection method for tag filtering.
Values	array	No	The list of tag filter values.
	string	No	The tag filter value.

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	success
Data	object	The returned query data.
PeriodCoverage	array<object>	The usage data for each time period.
	object
Percentage	number	The usage rate.	1
Period	string	The time period to which the data belongs, in the yyyyMMddHH format.	2021041500
TotalUsage	object	The overview of the total usage rate.
PoolValue	number	The total amount of the savings plan.	100
PostpaidCost	number	The pay-as-you-go cost.	200
SavedCost	number	The amount saved.	100
UsagePercentage	number	The total usage rate.	1
Message	string	The API call message.	Successful!
RequestId	string	The request ID.	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success	boolean	Indicates whether the API call is successful.	true

Examples

Success response

JSON format

{
  "Code": "success",
  "Data": {
    "PeriodCoverage": [
      {
        "Percentage": 1,
        "Period": "2021041500"
      }
    ],
    "TotalUsage": {
      "PoolValue": 100,
      "PostpaidCost": 200,
      "SavedCost": 100,
      "UsagePercentage": 1
    }
  },
  "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.