DocsICP FilingConsole
Documentation

DescribeSavingsPlansUsageDetail

Updated at:
Copy as MD
My Favorites

Queries the usage details of savings plans.

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 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.

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 covers data up to the current time.

2021-01-02 00:00:00
PeriodType

string

Yes

The time granularity for querying usage details. Valid values:

  • MONTH: monthly granularity.

  • DAY: daily granularity.

  • HOUR: hourly granularity.

HOUR
Token

string

No

The pagination token. Leave this parameter empty for the first page. The query result returns the 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.

300
BillOwnerId

integer

No

The ID of the account. 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
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
Data

object

The returned data.

Items

array<object>

The data items.

object

Currency

string

The currency.

CNY
DeductValue

number

The amount spent from the savings plan, which is the used commitment.

3.94
EndPeriod

string

The end time.

2021-08-09 00:00:00
InstanceId

string

The instance ID.

spn-a1fhs54c243hP22
PoolValue

number

The total amount of the savings plan.

29.84
PostpaidCost

number

The standard pay-as-you-go cost.

4.2
SavedCost

number

The net savings amount.

0.08
StartPeriod

string

The start time.

2021-08-01 00:00:00
Status

string

The current status. Valid values:

  • -1: overdue payment.

  • 1: active.

-1
Type

string

The type of the savings plan, such as general-purpose or ECS compute.

General-purpose
UsagePercentage

number

The usage percentage.

0.9
UserId

integer

The account ID.

123745698925000
UserName

string

The account name.

test13@test.aliyun.com
NextToken

string

The token for the next page.

eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9
TotalCount

integer

The total number of data records.

1000
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": [
      {
        "Currency": "CNY",
        "DeductValue": 3.94,
        "EndPeriod": "2021-08-09 00:00:00",
        "InstanceId": "spn-a1fhs54c243hP22",
        "PoolValue": 29.84,
        "PostpaidCost": 4.2,
        "SavedCost": 0.08,
        "StartPeriod": "2021-08-01 00:00:00",
        "Status": "-1",
        "Type": "通用型",
        "UsagePercentage": 0.9,
        "UserId": 123745698925000,
        "UserName": "test13@test.aliyun.com"
      }
    ],
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9",
    "TotalCount": 1000
  },
  "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.