DescribeResourceCoverageTotal - BSS OpenAPI - 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.

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:DescribeResourceCoverageTotal	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 total coverage data is queried. Valid values: MONTH, DAY, and HOUR.	HOUR
BillOwnerId	long	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 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.
PeriodCoverage	object []	The information about the coverage rate of deduction plans within a period.
CoveragePercentage	float	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	float	The total amount of the resources deducted from deduction plans.	1
CoveragePercentage	float	The total coverage rate of deduction plans.	1
TotalQuantity	float	The total amount of resources consumed.	1

Examples

Sample success responses

JSONformat

{
  "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

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