DescribeResourceCoverageDetail-阿里云帮助中心

Queries the coverage details of Reserved Instances (RIs) and Storage Capacity Units (SCUs).

Operation description

The data is consistent with the list data in the "Coverage Overview" section of the "Resource Instance Management" menu in User Center.
Coverage queries are supported for two resource types: RI and SCU.
Coverage queries are available at three granularity levels: "Hour", "Day", and "Month".

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	Format: yyyy-MM-dd HH:mm:ss. The query includes this time.	2021-01-01 00:00:00
EndPeriod	string	No	Format: yyyy-MM-dd HH:mm:ss. The query excludes 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	Valid values: MONTH: month granularity. DAY: day granularity. HOUR: hour granularity.	HOUR
NextToken	string	No	The pagination token. Leave this parameter empty for the first page. The response 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 read in this request. Default value: 20. Maximum value: 300.	200
BillOwnerId	integer	No	The ID of the resource ownership account. The resource ownership account is the account that actually uses the resource.	123745698925000
ResourceType	string	Yes	Valid values: RI: Reserved Instance. SCU: Storage Capacity Unit.	RI

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
CapacityUnit	string	The offset unit.	Computing power*Hour
CommodityCode	string	The commodity detail code.	ecs
CommodityName	string	The commodity detail name.	Elastic Compute Service (ECS)-Pay-As-You-Go
CoveragePercentage	number	The coverage percentage.	1
Currency	string	The currency.	CNY
DeductQuantity	number	The deducted quantity.	1
EndTime	string	The end time.	2021-04-01 01:00:00
InstanceId	string	The instance ID of the pay-as-you-go instance.	i-bp1d9x623987rlj0dx4xx
InstanceSpec	string	The instance specification.	ecs.t5-lc2m1.nano
PaymentAmount	number	The bill amount.	0
ProductCode	string	The product code.	ecs
ProductName	string	The product name.	Elastic Compute Service ECS
Region	string	The region.	China (Hangzhou)
RegionNo	string	The region code.	cn-hangzhou-dg-a01
StartTime	string	The start time.	2021-04-01 00:00:00
TotalQuantity	number	The total usage.	1
UserId	string	The account ID.	123745698925000
UserName	string	The account name.	test13@test.aliyun.com
Zone	string	The zone code.	cn-hangzhou-i
ZoneName	string	The zone name.	Hangzhou Zone I
MaxResults	integer	The number of entries on the current page.	200
NextToken	string	The token for the next page.	eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9
TotalCount	integer	The total number of entries.	10000
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": [
      {
        "CapacityUnit": "算力*小时",
        "CommodityCode": "ecs",
        "CommodityName": "云服务器ECS-按量付费",
        "CoveragePercentage": 1,
        "Currency": "CNY",
        "DeductQuantity": 1,
        "EndTime": "2021-04-01 01:00:00",
        "InstanceId": "i-bp1d9x623987rlj0dx4xx",
        "InstanceSpec": "ecs.t5-lc2m1.nano",
        "PaymentAmount": 0,
        "ProductCode": "ecs",
        "ProductName": "云服务器 ECS",
        "Region": "华东1（杭州）",
        "RegionNo": "cn-hangzhou-dg-a01",
        "StartTime": "2021-04-01 00:00:00",
        "TotalQuantity": 1,
        "UserId": "123745698925000",
        "UserName": "test13@test.aliyun.com",
        "Zone": "cn-hangzhou-i",
        "ZoneName": "杭州 可用区I"
      }
    ],
    "MaxResults": 200,
    "NextToken": "eyJwYWdlTnVtIjoyLCJwYWdlU2l6ZSI6MTB9",
    "TotalCount": 10000
  },
  "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.