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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeResourceUsageTotal

The operation that you want to perform. Set the value to DescribeResourceUsageTotal.

Response parameters

Parameter Type Example Description
Code String Success

The status code.

Data Struct

The returned data.

PeriodCoverage Array of Item

The information about the usage of deduction plans within a period.

Period String 2021041500

The period.

UsagePercentage Float 0.1

The usage of deduction plans within the specified period.

TotalUsage Struct

The information about the total usage data of deduction plans.

PostpaidCost Float 100

The total costs of pay-as-you-go instances.

PotentialSavedCost Float 100

The total potential savings.

ReservationCost Float 10

The fee of purchased deduction plans.

SavedCost Float 90

The total savings.

UsagePercentage Float 1

The total usage of deduction plans.

Message String Successful!

The message returned.

RequestId String 79EE7556-0CFD-44EB-9CD6-B3B526E3A85F

The ID of the request.

Success Boolean true

Indicates whether the operation was successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeResourceUsageTotal
&PeriodType=HOUR
&ResourceType=RI
&StartPeriod=2021-01-01 00:00:00
&<Common request parameters>

Sample success responses

JSON format

{"Message":"Successful!","RequestId":"79EE7556-0CFD-44EB-9CD6-B3B526E3A85F","Data":{"PeriodCoverage":[{"Period":"2021041500","UsagePercentage":"0.1"}],"TotalUsage":{"ReservationCost":"10","PostpaidCost":"100","SavedCost":"90","PotentialSavedCost":"100","UsagePercentage":"1"}},"Code":"Success","Success":"true"}

Error codes

For a list of error codes, visit the API Error Center.