Cloud Virtual Machine
- Release Notes and Announcements
- Announcements
- Product Introduction
- Image
- Public Image
- TencentOS Server
- Network and Security
- OPS and Monitoring
- Purchase Guide
- Purchasing Instances
- Purchasing Cloud Disks
- Purchasing Reserved Instances
- Purchasing Public Network Bandwidth
- Getting Started
- Operation Guide
- Convenience Features
- Instances
- Creating Instances
- Logging In to Linux Instances
- Logging in to Windows instance
- Adjusting Configuration
- View Instance Details
- Managing Instance IPs
- Terminating/Returning Instances
- Reserved Instances
- Images
- Importing Images
- CentOS Linux Operations
- Migrating Servers
- Online Migration
- Migration Operation Guide
- Maintenance Tasks
- Networking
- Security
- Security Groups
- Managing Security Groups
- Managing Security Group Rules
- Monitoring and Alarms
- Practical Tutorial
- Building an Environment
- Setting up LNMP
- Setting up LAMP manually
- Setting up Java Web
- Setting up Node.js
- Manual Setup of WIPM Environment
- Building a Website
- Discuz! Forum
- Building an Application
- Setting Up FTP Site
- NTP Service
- Building a Visual GUI
- Uploading Local Files to CVM
- High-throughput Network Performance Test
- Operations Guide
- Initializing Data Disks
- Environment Configurations
- Installing Software
- Work with Operating Systems
- Troubleshooting
- Instance-Related Failures
- Windows Instance Login Failures
- Linux Instance Login Failures
- Linux CVM Memory Issues
- API Documentation
- Region APIs
- Instance APIs
- Cloud Hosting Cluster APIs
- Image APIs
- Instance Launch Template APIs
- Making API Requests
- Placement Group APIs
- Key APIs
- Security Group APIs
- Network APIs
- FAQs
- Billing
- Instance
- Storage
- Images
- OPS & Monitoring
- Related Agreement
DescribeReservedInstances
Last updated: 2025-03-13 14:28:42
1. API Description
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.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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. |
| 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. |
3. Output Parameters
| 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. |
4. Example
Example1 Listing Purchased Reserved Instances
This example shows you how to list purchased reserved instances.
Input Example
GET https://cvm.intl.tencentcloudapi.com/?Action=DescribeReservedInstances
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Limit=1
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 1,
"ReservedInstancesSet": [
{
"ReservedInstanceId": "ri-rtbh4han",
"ReservedInstancesId": "ri-rtbh4han",
"ReservedInstanceName": "riname-01",
"InstanceType": "S3.16XLARGE256",
"InstanceFamily": "S3",
"Zone": "ap-guangzhou-1",
"StartTime": "0000-00-00 00:00:00",
"EndTime": "0000-00-00 00:00:00",
"Duration": 31536000,
"InstanceCount": 1,
"ProductDescription": "linux",
"State": "active",
"CurrencyCode": "USD",
"OfferingType": "All Upfront"
}
],
"RequestId": "9cb3dd3d-5717-47c4-bf3b-05c7ddb4655b"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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 | Filter |
| 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.
Yes
No