文档中心>云服务器>API 文档>实例相关接口>查询预留实例机型配置参数

查询预留实例机型配置参数

最近更新时间:2024-03-12 01:19:25

我的收藏

1. 接口描述

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

本接口(DescribeReservedInstancesConfigInfos)供用户列出可购买预留实例机型配置。预留实例当前只针对国际站白名单用户开放。

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeReservedInstancesConfigInfos。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter zone
按照预留实例计费可购买的可用区进行过滤。形如:ap-guangzhou-1。
类型:String
必选:否
可选项:各地域可用区列表

product-description
按照预留实例计费的平台描述(即操作系统)进行过滤。形如:linux。
类型:String
必选:否
可选项:linux

duration
按照预留实例计费有效期,即预留实例计费购买时长进行过滤。形如:31536000。
类型:Integer
计量单位:秒
必选:否
可选项:31536000 (1年)

3. 输出参数

参数名称 类型 描述
ReservedInstanceConfigInfos Array of ReservedInstanceConfigInfoItem 预留实例静态配置信息列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询预留实例机型配置

查询预留实例机型配置

输入示例

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReservedInstancesConfigInfos
<公共请求参数>

{
    "Filters": [
        {
            "Name": "zone",
            "Values": [
                "ap-guangzhou-1"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "ReservedInstanceConfigInfos": [
            {
                "Type": "C",
                "TypeName": "计算型",
                "Order": 0,
                "InstanceFamilies": [
                    {
                        "InstanceFamily": "abc",
                        "Order": 402,
                        "InstanceTypes": [
                            {
                                "InstanceType": "C3.LARGE8",
                                "Cpu": 4,
                                "Memory": 8,
                                "Gpu": 0,
                                "Fpga": 0,
                                "StorageBlock": 0,
                                "NetworkCard": 0,
                                "MaxBandwidth": 0,
                                "Frequency": "2.5",
                                "CpuModelName": "Intel Xeon Skylake 6146",
                                "Pps": 60,
                                "Externals": {
                                    "ReleaseAddress": true,
                                    "UnsupportNetworks": [],
                                    "StorageBlockAttr": {
                                        "Type": "",
                                        "MinSize": 0,
                                        "MaxSize": 0
                                    }
                                },
                                "Remark": "",
                                "Prices": [
                                    {
                                        "ReservedInstancesOfferingId": "d81353d7-fe7d-43d0-a361-fb5633a9a7e5",
                                        "OfferingType": "No Upfront",
                                        "FixedPrice": 0,
                                        "UsagePrice": 2.99,
                                        "Duration": 1,
                                        "Zone": "ap-guangzhou-1",
                                        "ProductDescription": ""
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "RequestId": "87eccd3e-9e7a-4b42-be3a-87eccd3e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidFilter 无效的过滤器。
InvalidZone.MismatchRegion 指定的zone不存在。
UnsupportedOperation.InvalidPermissionNonInternationalAccount 当前操作只支持国际版用户。
UnsupportedOperation.ReservedInstanceInvisibleForUser 当前用户暂不支持购买预留实例计费。