DescribeSavingsPlansUsageDetail - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the usage details of savings plans.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StartPeriod	string	Yes	The beginning of the time range to query. The beginning is included in the time range. Specify the time in the format of 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 is excluded from the time range. If you do not set this parameter, the end time is the current time. Specify the time in the format of yyyy-MM-dd HH:mm:ss.	2021-01-02 00:00:00
PeriodType	string	Yes	The time granularity at which usage details are queried. Valid values: MONTH, DAY, and HOUR.	HOUR
Token	string	No	The token that is used to retrieve the next page of results. You do not need to set this parameter if you query usage details within a specific time range for the first time. The response returns a token that you can use to query usage details that are displayed on the next page. If a null value is returned for the NextToken parameter, no more coverage details can be queried.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
MaxResults	integer	No	The maximum number of entries to return. Default value: 20. Maximum value: 300.	300
BillOwnerId	long	No	The ID of the account for which you want to query usage details. If you do not set this parameter, the data of the current Alibaba Cloud account and its RAM users is queried. To query the data of a RAM user, specify the ID of the RAM user.	123745698925000

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The message returned.	Successful!
RequestId	string	The ID of the request.	79EE7556-0CFD-44EB-9CD6-B3B526E3A85F
Success	boolean	Indicates whether the operation was successful.	true
Data	object	The return data.
TotalCount	integer	The total number of entries.	1000
NextToken	string	The token of the next page.	eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9
Items	array<object>	The data entries.
	object
Status	string	The status of the instance. A value of -1 indicates that the payment is overdue. A value of 1 indicates that the instance is active.	-1
Type	string	The type of the savings plan. Valid values: universal and ECS compute.
UsagePercentage	float	The usage.	0.9
UserId	long	The ID of the account.	123745698925000
InstanceId	string	The ID of the instance.	spn-a1fhs54c243hP22
Currency	string	The currency.	CNY
PostpaidCost	float	The pay-as-you-go cost.	4.2
DeductValue	float	The used amount of the savings plan.	3.94
StartPeriod	string	The start time.	2021-08-01 00:00:00
SavedCost	float	The amount that is saved.	0.08
PoolValue	float	The total amount of the savings plan.	29.84
UserName	string	The username of the account.	test13@test.aliyun.com
EndPeriod	string	The end time.	2021-08-09 00:00:00

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "TotalCount": 1000,
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2ldhsSI6MTB9",
    "Items": [
      {
        "Status": "-1",
        "Type": "",
        "UsagePercentage": 0.9,
        "UserId": 123745698925000,
        "InstanceId": "spn-a1fhs54c243hP22",
        "Currency": "CNY",
        "PostpaidCost": 4.2,
        "DeductValue": 3.94,
        "StartPeriod": "2021-08-01 00:00:00",
        "SavedCost": 0.08,
        "PoolValue": 29.84,
        "UserName": "test13@test.aliyun.com",
        "EndPeriod": "2021-08-09 00:00:00"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.