列出已购买的预留实例-云服务器-文档中心-腾讯云

1. 接口描述

接口请求域名： cvm.tencentcloudapi.com 。

本接口(DescribeReservedInstances)可提供列出用户已购买的预留实例

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeReservedInstances。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DryRun	否	Boolean	试运行。默认为 false。示例值：false
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：1
Filters.N	否	Array of Filter	zone 按照预留实例计费可购买的【可用区】进行过滤。形如：ap-guangzhou-1。类型：String 必选：否可选项：可用区列表 duration 按照预留实例计费【有效期】即预留实例计费购买时长进行过滤。形如：31536000。类型：Integer 计量单位：秒必选：否可选项：31536000 (1年) \| 94608000（3年） instance-type 按照【预留实例规格】进行过滤。形如：S3.MEDIUM4。类型：String 必选：否可选项：预留实例规格列表 instance-family 按照【预留实例类型】进行过滤。形如：S3。类型：String 必选：否可选项：预留实例类型列表 offering-type offering-type 按照【付款类型】进行过滤。形如：All Upfront (全预付)。类型：String 必选：否可选项：All Upfront (全预付) \| Partial Upfront (部分预付) \| No Upfront (零预付) product-description 按照预留实例计费的【平台描述】（即操作系统）进行过滤。形如：linux。类型：String 必选：否可选项：linux reserved-instances-id 按照已购买【预留实例计费ID】进行过滤。形如：650c138f-ae7e-4750-952a-96841d6e9fc1。类型：String 必选：否 state 按照已购买【预留实例计费状态】进行过滤。形如：active。类型：String 必选：否可选项：active (已创建) \| pending (等待被创建) \| retired (过期) 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的预留实例计费数量。示例值：1
ReservedInstancesSet	Array of ReservedInstances	符合条件的预留实例计费列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 列出已购买预留实例计费

列出已购买预留实例计费

输入示例

GET https://cvm.tencentcloudapi.com/?Action=DescribeReservedInstances
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Limit=1
&<公共请求参数>

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalServerError	操作内部错误。
InvalidFilter	无效的过滤器。
InvalidFilterValue.LimitExceeded	`Filter`。
InvalidInstanceType.Malformed	指定InstanceType参数格式不合法。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。
UnsupportedOperation.InvalidPermissionNonInternationalAccount	当前操作只支持国际版用户。
UnsupportedOperation.ReservedInstanceInvisibleForUser	当前用户暂不支持购买预留实例计费。

列出已购买的预留实例

本页目录：