DescribeSavingsPlansCoverageDetail - Expenses and Costs - Alibaba Cloud Documentation Center

Queries detailed information about savings plan coverage.

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 beginning of the time range to query. The start time is inclusive. The time format is yyyy-MM-dd HH:mm:ss.	2021-01-01 00:00:00
EndPeriod	string	No	The end of the time range to query. The end time is exclusive. If you do not set this parameter, the current time is used as the end time. The time format is yyyy-MM-dd HH:mm:ss.	2021-01-01 00:00:00
PeriodType	string	Yes	The time granularity for the usage summary. Valid values: MONTH, DAY, and HOUR.	HOUR
Token	string	No	The token for paging. Leave this empty for the first query. The response includes a token for the next page. An empty token means all data has been returned.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
MaxResults	integer	No	The maximum number of results to return.	20
BillOwnerId	integer	No	The ID of the account that owns the resource. The resource owner is the account that uses the resource.	123745698925000
FilterParam	object	No
Dimensions	array<object>	No
	object	No
Code	string	No
SelectType	string	No
Values	array	No
	string	No
Tags	array<object>	No
	object	No
Code	string	No
SelectType	string	No
Values	array	No
	string	No

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	success
Message	string	The message returned for the call.	Successful!
RequestId	string	The request ID.	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success	boolean	Indicates whether the call was successful.	true
Data	object	The data returned.
TotalCount	integer	The total number of data entries.	100
NextToken	string	The token for the next page.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
Items	array<object>	The data items.
	object
UserId	integer	The user ID.	1906589291020438
OwnerId	integer	The ID of the owner of the resource for which costs were deducted.	1906589291020438
InstanceId	string	The instance ID.	i-bp1d9x623987rlj0dx4xx
Currency	string	The currency.	CNY
InstanceSpec	string	The instance type.	ecs.sn1ne.3xlarge
PostpaidCost	number	The pay-as-you-go cost.	200
CoveragePercentage	number	The coverage percentage.	0.9
Region	string	The region.	华东1（杭州）
DeductAmount	number	The deducted amount.	5.5
StartPeriod	string	The start time.	2023-04-01 00:00:00
TotalAmount	number	The total cost.	6.11
UserName	string	The username of the account.	xxx@test.aliyunid.com
EndPeriod	string	The end time.	2023-05-01 00:00:00

Examples

Success response

JSON format

{
  "Code": "success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "TotalCount": 100,
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
    "Items": [
      {
        "UserId": 1906589291020438,
        "OwnerId": 1906589291020438,
        "InstanceId": "i-bp1d9x623987rlj0dx4xx",
        "Currency": "CNY",
        "InstanceSpec": "ecs.sn1ne.3xlarge",
        "PostpaidCost": 200,
        "CoveragePercentage": 0.9,
        "Region": "华东1（杭州）",
        "DeductAmount": 5.5,
        "StartPeriod": "2023-04-01 00:00:00",
        "TotalAmount": 6.11,
        "UserName": "xxx@test.aliyunid.com",
        "EndPeriod": "2023-05-01 00:00:00"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.