DescribeResourceCoverageTotal - Expenses and Costs - Alibaba Cloud Documentation Center

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

Operation description

The queried total coverage data is the same as the aggregated data displayed on the Coverage tab of the Manage Reserved Instances page in the Billing Management console.

You can call this operation to query the total coverage data of RIs or 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 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 total coverage data is queried. Valid values: MONTH, DAY, and HOUR.	HOUR
BillOwnerId	integer	No	The ID of the account for which you want to query total coverage data. 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 total coverage data is 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.
PeriodCoverage	array<object>	The information about the coverage rate of deduction plans within a period.
	object
CoveragePercentage	number	The coverage rate of deduction plans within the specified period.	0.1
Period	string	The period. The value is in the format of yyyyMMddHH.	2020110100
TotalCoverage	object	The information about the total coverage data of deduction plans.
CapacityUnit	string	The unit that is used to measure the resources deducted from deduction plans.	算力*小时
DeductQuantity	number	The total amount of the resources deducted from deduction plans.	1
CoveragePercentage	number	The total coverage rate of deduction plans.	1
TotalQuantity	number	The total amount of resources consumed.	1

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "PeriodCoverage": [
      {
        "CoveragePercentage": 0.1,
        "Period": "2020110100"
      }
    ],
    "TotalCoverage": {
      "CapacityUnit": "算力*小时",
      "DeductQuantity": 1,
      "CoveragePercentage": 1,
      "TotalQuantity": 1
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.