Query reserved instance usage details by using QueryRIUtilizationDetail - Expenses and Costs - Alibaba Cloud - Expenses and Costs

Queries the usage of reserved instances (RIs).

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

bss:QueryRiUtilizationDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RIInstanceId	string	No	The instance ID of the reserved instance for the filtered query. If this parameter is left empty, the details of all used reserved instances are returned.	dsudfgdsjh
InstanceSpec	string	No	The instance type corresponding to the reserved instance.	Instancetyp
RICommodityCode	string	Yes	Valid values: ecsRi: ECS reserved instances. This is the default value. scu_bag: Storage capacity unit (SCU) plans.	ecsRi
DeductedInstanceId	string	No	The ID of the deducted instance. If this parameter is left empty, the details of all instances are returned.	jsdgfsdhgsdjh
StartTime	string	Yes	The start time. Format: YYYY-MM-DD HH:mm:ss.	2019-05-23 12:00:00
EndTime	string	Yes	The end time. Format: YYYY-MM-DD HH:mm:ss.	2019-05-23 12:00:00
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 300.	20

Response elements

Element	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The error message.	Successful！
RequestId	string	The request ID.	DF58589C-A06C-4224-8615-7797E6474FA3
Success	boolean	Indicates whether the request is successful.	true
Data	object	The returned data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	0
DetailList	object
DetailList	array<object>	The detail array.
	object
DeductedCommodityCode	string	The commodity code of the deducted resource.	rds
DeductedProductDetail	string	The name of the deducted product.	ApsaraDB RDS
DeductedInstanceId	string	The instance ID of the deducted instance.	safdffghfgh
DeductFactorTotal	number	The total computing power or capacity of the RI or SCU during the specified time period.	1
DeductQuantity	number	The actual computing power or capacity deducted for the corresponding pay-as-you-go instance.	1
DeductHours	string	The deduction factor. This parameter is valid only when RICommodityCode is set to ecsRi.	24
DeductDate	string	The deduction date. Format: YYYY-MM-DD HH:mm:ss.	2019-05-23 12:00:00
RIInstanceId	string	The instance ID of the reserved instance.	324253645
InstanceSpec	string	The instance type of the deducted instance.	rds.mysql.s3.large

Examples

Success response

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": "云数据库RDS",
          "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.