DescribeResourceCoverageDetail - BSS OpenAPI - Alibaba Cloud Documentation Center

Queries the coverage details of reserved instances (RIs) or storage capacity units (SCUs).

Operation description

1. The queried coverage details are the same as those displayed in the table on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.

2. You can call this operation to query the coverage details of RIs or SCUs.

3. You can call this operation to query coverage details at an hourly, daily, or monthly granularity.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
bssapi:DescribeResourceCoverageDetail	Read	All Resources *	none	none

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 coverage details are queried. Valid values: MONTH, DAY, and HOUR.	HOUR
NextToken	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 coverage details within a specific time range for the first time. The response returns a token that you can use to query coverage 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.	200
BillOwnerId	long	No	The ID of the account for which you want to query coverage 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
ResourceType	string	Yes	The type of deduction plans whose coverage details are queried. Valid values: RI and SCU.	RI

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 returned data.
NextToken	string	The token of the next page.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
TotalCount	integer	The total number of entries returned.	10000
MaxResults	integer	The number of entries returned on the current page.	200
Items	object []	The data entries.
CommodityCode	string	The code of the service.	ecs
ProductName	string	The name of the service.
TotalQuantity	float	The total amount of resources consumed.	1
RegionNo	string	The code of the region.	cn-hangzhou-dg-a01
UserId	string	The ID of the account.	123745698925000
CommodityName	string	The name and billing method of the service.
CapacityUnit	string	The unit that is used to measure the resources deducted from deduction plans.
InstanceId	string	The ID of a pay-as-you-go instance.	i-bp1d9x623987rlj0dx4xx
Currency	string	The currency in which deduction plans were priced.	CNY
ZoneName	string	The zone.
InstanceSpec	string	The specifications of a deduction plan.	ecs.t5-lc2m1.nano
EndTime	string	The end of the time range in which the coverage details were queried.	2021-04-01 01:00:00
StartTime	string	The beginning of the time range in which the coverage details were queried.	2021-04-01 00:00:00
PaymentAmount	float	The amount of the bill.	0
CoveragePercentage	float	The coverage rate of a deduction plan.	1
Region	string	The region.
DeductQuantity	float	The amount of the resources deducted from a deduction plan.	1
Zone	string	The code of the zone.	cn-hangzhou-i
UserName	string	The username of the account.	test13@test.aliyun.com
ProductCode	string	The code of the service.	ecs

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
    "TotalCount": 10000,
    "MaxResults": 200,
    "Items": [
      {
        "CommodityCode": "ecs",
        "ProductName": "",
        "TotalQuantity": 1,
        "RegionNo": "cn-hangzhou-dg-a01",
        "UserId": "123745698925000",
        "CommodityName": "",
        "CapacityUnit": "",
        "InstanceId": "i-bp1d9x623987rlj0dx4xx",
        "Currency": "CNY",
        "ZoneName": "",
        "InstanceSpec": "ecs.t5-lc2m1.nano",
        "EndTime": "2021-04-01 01:00:00",
        "StartTime": "2021-04-01 00:00:00",
        "PaymentAmount": 0,
        "CoveragePercentage": 1,
        "Region": "",
        "DeductQuantity": 1,
        "Zone": "cn-hangzhou-i",
        "UserName": "test13@test.aliyun.com",
        "ProductCode": "ecs"
      }
    ]
  }
}

Error codes

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