DescribeResourceCoverageTotal-阿里云帮助中心

Queries the coverage summary of reserved instances and storage capacity units (SCUs).

Operation description

Returns the same summary data as the Coverage Overview in the Resource Instance Management menu of the User Center. Currently, coverage queries are supported for two resource types: reserved instances (RIs) and storage capacity units (SCUs).

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:DescribeResourceCoverageTotal

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartPeriod	string	Yes	The start of the query time range. Format: yyyy-MM-dd HH:mm:ss. The query includes this time.	2021-01-01 00:00:00
EndPeriod	string	No	The end of the query time range. Format: yyyy-MM-dd HH:mm:ss. The query excludes this time. If this parameter is left empty, the current time is used.	2021-01-02 00:00:00
PeriodType	string	Yes	The time granularity. Valid values: MONTH: month DAY: day HOUR: hour	HOUR
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	The resource type. 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.
PeriodCoverage	array<object>	The coverage rate by time period.
	object
CoveragePercentage	number	The coverage rate.	0.1
Period	string	The time period. Format: yyyyMMddHH.	2020110100
TotalCoverage	object	The total coverage rate.
CapacityUnit	string	The offset unit.	Computing power*hours
CoveragePercentage	number	The total coverage rate.	1
DeductQuantity	number	The total offset amount.	1
TotalQuantity	number	The total usage.	1
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": {
    "PeriodCoverage": [
      {
        "CoveragePercentage": 0.1,
        "Period": "2020110100"
      }
    ],
    "TotalCoverage": {
      "CapacityUnit": "算力*小时",
      "CoveragePercentage": 1,
      "DeductQuantity": 1,
      "TotalQuantity": 1
    }
  },
  "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.