All Products
Search
Document Center

BSS OpenAPI:QueryRIUtilizationDetail

Last Updated:Mar 01, 2024

Queries the usage details of a reserved instance (RI).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
bss:QueryRIUtilizationDetailREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RIInstanceIdstringNo

The ID of the RI. If this parameter is left empty, the usage details of all RIs are queried.

dsudfgdsjh
InstanceSpecstringNo

The instance type of the RI.

Instancetyp
RICommodityCodestringYes

The code of the service to which the RI is applied. Default value: ecsRi. Valid values:

  • ecsRi: ECS RI.
  • scu_bag: storage capacity unit (SCU).
ecsRi
DeductedInstanceIdstringNo

The ID of the instance whose fees are deducted by using the RI. If this parameter is left empty, the usage details of all instances are queried.

jsdgfsdhgsdjh
StartTimestringYes

The time when the RI was created. Specify the time in the YYYY-MM-DD HH:mm:ss format.

2019-05-23 12:00:00
EndTimestringYes

The time when the RI expires. Specify the time in the YYYY-MM-DD HH:mm:ss format.

2019-05-23 12:00:00
PageNumintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. Maximum value: 300.

20

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request.

DF58589C-A06C-4224-8615-7797E6474FA3
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNumlong

The number of the returned page.

1
PageSizelong

The number of entries returned per page.

20
TotalCountlong

The total number of returned entries.

0
DetailListobject []

The usage details of the RI.

DeductedCommodityCodestring

The code of the service whose fees are deducted by using the RI.

rds
DeductedProductDetailstring

The name of the service whose fees are deducted by using the RI.

ApsaraDB RDS
DeductedInstanceIdstring

The ID of the instance whose fees are deducted by using the RI.

safdffghfgh
DeductFactorTotalfloat

The total amount of computing power of the RI or capacity of SCU in the time period.

1
DeductQuantityfloat

The computing power or capacity of the pay-as-you-go instance whose fees are deducted by using the RI.

1
DeductHoursstring

The deduct factor. This parameter is returned only if the RICommodityCode parameter is set to ecsRi.

24
DeductDatestring

The time when the fees are deducted by using the RI.

2019-05-23 12:00:00
RIInstanceIdstring

The ID of the RI.

324253645
InstanceSpecstring

The instance type of the instance whose fees are deducted by using the RI.

rds.mysql.s3.large

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "DF58589C-A06C-4224-8615-7797E6474FA3",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 0,
    "DetailList": {
      "DetailList": [
        {
          "DeductedCommodityCode": "rds",
          "DeductedProductDetail": "ApsaraDB RDS\n",
          "DeductedInstanceId": "safdffghfgh",
          "DeductFactorTotal": 1,
          "DeductQuantity": 1,
          "DeductHours": "24",
          "DeductDate": "2019-05-23 12:00:00",
          "RIInstanceId": "324253645",
          "InstanceSpec": "rds.mysql.s3.large"
        }
      ]
    }
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NotApplicableThis API is not applicable for caller.-
400NotAuthorizedThis API is not authorized for caller.-
400MissingParameterAbsent some mandatory parameter for this request.-
400InvalidParameterThis request contain some invalid parameter-
400InvalidOwnerThe specified owner doesn't belong to caller.Invalid user identity.
400InternalErrorThe request processing has failed due to some unknown error.-
400InvalidQueryTimeThe specified start time and end time are incorrect-
400InvalidInstanceSpecThe specified Instance specification is not valid.-
400CommodityNotSupportedThe specified RI commodity is not supported.-

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