Release Notes
Public Image Release Notes
Official End of Support Plan for the Operating System
Announcements
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to list the reserved instances purchased by the user.
A maximum of 10 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeReservedInstances. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DryRun | No | Boolean | Trial run. Default value: false. |
| Offset | No | Integer | Offset. Default value: 0. For more information on Offset, see the relevant section in API Introduction. |
| Limit | No | Integer | Number of returned instances. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section in API Introduction. |
| Filters.N | No | Array of Filter | Filter by [availability zones] in which reserved instances can be purchased. For example, ap-guangzhou-1. Type: String. Required: No. Valid values: See the availability zone list. Filter by [validity periods] of reserved instances, which is the instance purchase duration. For example, 31536000. Type: Integer. Unit: Second. Required: No. Valid values: 31536000 (1 year) | 94608000 (3 years). Filter by [specifications of reserved instances]. For example, S3.MEDIUM4. Type: String. Required: No. Valid values: See the reserved instance specification list. Filter by [types of reserved instances]. For example, S3. Type: String. Required: No. Valid values: See the reserved instance type list. Filter by payment types]. For example, All Upfront (fully prepaid). Type: String. Required: No. Valid values: All Upfront (fully prepaid) | Partial Upfront (partially prepaid) | No Upfront (non-prepaid). Filter by [platform descriptions] (operating system) of reserved instances. For example, linux. Type: String. Required: No. Valid value: linux. Filter by [IDs of purchased reserved instances]. For example, 650c138f-ae7e-4750-952a-96841d6e9fc1. Type: String. Required: No. Filter by [statuses of purchased reserved instances]. For example, active. Type: String. Required: No. Valid values: active (created) | pending (waiting to be created) | retired (expired). Each request can have up to 10 filters, and each filter can have up to 5 values. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of reserved instances that meet the conditions. |
| ReservedInstancesSet | Array of ReservedInstances | List of reserved instances that meet the conditions. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to list purchased reserved instances.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReservedInstances
<Common request parameters>
{
"Offset": 0,
"Limit": 1,
"Filters": [
{
"Name": "zone",
"Values": [
"ap-singapore-1"
]
}
]
}{
"Response": {
"RequestId": "dcb99aa2-f50d-43c6-aadd-74775f016db2",
"ReservedInstancesSet": [
{
"CurrencyCode": "USD",
"Duration": 31536000,
"EndTime": "2024-07-30 10:59:59",
"InstanceCount": 1,
"InstanceFamily": "S5",
"InstanceType": "S5.MEDIUM2",
"OfferingType": "No Upfront",
"ProductDescription": "linux",
"ReservedInstanceId": "ri-je53w05q",
"ReservedInstanceName": "Unnamed",
"StartTime": "2023-07-31 10:00:00",
"State": "retired",
"Zone": "ap-singapore-1"
}
],
"TotalCount": 3
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalServerError | Internal error. |
| InvalidFilter | Invalid filter. |
| InvalidFilterValue.LimitExceeded | The value of Filter exceeds the limit. |
| InvalidInstanceType.Malformed | The specified InstanceType parameter has an invalid format. |
| InvalidParameter | A parameter error occurred. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| UnsupportedOperation.InvalidPermissionNonInternationalAccount | The current operation is supported only for Tencent Cloud users. |
| UnsupportedOperation.ReservedInstanceInvisibleForUser | Purchasing reserved instances is not supported for the current user. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback