Queries the usage details of a reserved instance (RI).
Debugging
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 |
---|---|---|---|---|
bss:QueryRIUtilizationDetail | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RIInstanceId | string | No | The ID of the RI. If this parameter is left empty, the usage details of all RIs are queried. | dsudfgdsjh |
InstanceSpec | string | No | The instance type of the RI. | Instancetyp |
RICommodityCode | string | Yes | The code of the service to which the RI is applied. Default value: ecsRi. Valid values:
| ecsRi |
DeductedInstanceId | string | No | 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 |
StartTime | string | Yes | 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 |
EndTime | string | Yes | The time when the RI expires. Specify the time in the YYYY-MM-DD HH:mm:ss format. | 2019-05-23 12:00:00 |
PageNum | integer | No | The number of the page to return. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Default value: 20. Maximum value: 300. | 20 |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | NotApplicable | This API is not applicable for caller. | - |
400 | NotAuthorized | This API is not authorized for caller. | - |
400 | MissingParameter | Absent some mandatory parameter for this request. | - |
400 | InvalidParameter | This request contain some invalid parameter | - |
400 | InvalidOwner | The specified owner doesn't belong to caller. | Invalid user identity. |
400 | InternalError | The request processing has failed due to some unknown error. | - |
400 | InvalidQueryTime | The specified start time and end time are incorrect | - |
400 | InvalidInstanceSpec | The specified Instance specification is not valid. | - |
400 | CommodityNotSupported | The specified RI commodity is not supported. | - |
For a list of error codes, visit the Service error codes.