DocsICP FilingConsole
Documentation

DescribeSavingsPlansCoverageDetail

Updated at:
Copy as MD
My Favorites

Queries the coverage 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 beginning of the time range to query. The start time is included in the time range. Format: 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 excluded from the time range. If you do not set this parameter, the end time is the current time. Format: yyyy-MM-dd HH:mm:ss.

2021-01-01 00:00:00
PeriodType

string

Yes

The time granularity for querying the usage summary. Valid values: MONTH, DAY, HOUR.

HOUR
Token

string

No

The pagination token. Leave this parameter empty for the first page. The response returns the token for the next page. An empty token in the response indicates that all data has been returned.

eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
MaxResults

integer

No

The maximum number of entries to return.

20
BillOwnerId

integer

No

The ID of the resource ownership account. The resource ownership account is the account that actually 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
Data

object

The returned query data.

Items

array<object>

The data items.

object

CoveragePercentage

number

The coverage percentage.

0.9
Currency

string

The currency.

CNY
DeductAmount

number

The deducted amount.

5.5
EndPeriod

string

The end time.

2023-05-01 00:00:00
InstanceId

string

The instance ID.

i-bp1d9x623987rlj0dx4xx
InstanceSpec

string

The instance type.

ecs.sn1ne.3xlarge
OwnerId

integer

The ID of the owner of the deducted commodity.

1906589291020438
PostpaidCost

number

The pay-as-you-go cost.

200
Region

string

The region.

China (Hangzhou)
StartPeriod

string

The start time.

2023-04-01 00:00:00
TotalAmount

number

The total expenditure.

6.11
UserId

integer

The user ID.

1906589291020438
UserName

string

The username.

xxx@test.aliyunid.com
NextToken

string

The token for the next page.

eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
TotalCount

integer

The total number of entries.

100
Message

string

The message returned for the API call.

Successful!
RequestId

string

The request ID.

79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success

boolean

Indicates whether the API call was successful.

true

Examples

Success response

JSON format

{
  "Code": "success",
  "Data": {
    "Items": [
      {
        "CoveragePercentage": 0.9,
        "Currency": "CNY",
        "DeductAmount": 5.5,
        "EndPeriod": "2023-05-01 00:00:00",
        "InstanceId": "i-bp1d9x623987rlj0dx4xx",
        "InstanceSpec": "ecs.sn1ne.3xlarge",
        "OwnerId": 1906589291020438,
        "PostpaidCost": 200,
        "Region": "华东1（杭州）",
        "StartPeriod": "2023-04-01 00:00:00",
        "TotalAmount": 6.11,
        "UserId": 1906589291020438,
        "UserName": "xxx@test.aliyunid.com"
      }
    ],
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
    "TotalCount": 100
  },
  "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.