DescribeResourceCoverageDetail - Expenses and Costs - 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.

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

bssapi:DescribeResourceCoverageDetail

get

*All Resource

*

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	integer	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 elements

Element	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	array<object>	The data entries.
	object
CommodityCode	string	The code of the service.	ecs
ProductName	string	The name of the service.	云服务器 ECS
TotalQuantity	number	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.	云服务器ECS-按量付费
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.	杭州可用区I
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	number	The amount of the bill.	0
CoveragePercentage	number	The coverage rate of a deduction plan.	1
Region	string	The region.	华东1（杭州）
DeductQuantity	number	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

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
    "TotalCount": 10000,
    "MaxResults": 200,
    "Items": [
      {
        "CommodityCode": "ecs",
        "ProductName": "云服务器 ECS",
        "TotalQuantity": 1,
        "RegionNo": "cn-hangzhou-dg-a01",
        "UserId": "123745698925000",
        "CommodityName": "云服务器ECS-按量付费",
        "CapacityUnit": "算力*小时",
        "InstanceId": "i-bp1d9x623987rlj0dx4xx",
        "Currency": "CNY",
        "ZoneName": "杭州 可用区I",
        "InstanceSpec": "ecs.t5-lc2m1.nano",
        "EndTime": "2021-04-01 01:00:00",
        "StartTime": "2021-04-01 00:00:00",
        "PaymentAmount": 0,
        "CoveragePercentage": 1,
        "Region": "华东1（杭州）",
        "DeductQuantity": 1,
        "Zone": "cn-hangzhou-i",
        "UserName": "test13@test.aliyun.com",
        "ProductCode": "ecs"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.