有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口(DescribeZoneInstanceConfigInfos) 获取可用区的机型信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeZoneInstanceConfigInfos。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter
  • zone

  • 按照【可用区】进行过滤。可用区形如:ap-guangzhou-1。

    类型:String

    必选:否

    可选项:可用区列表


  • instance-family

  • 按照【实例机型系列】进行过滤。实例机型系列形如:S1、I1、M1等。具体取值参见实例类型描述。

    类型:String

    必选:否


  • instance-type

  • 按照【实例机型】进行过滤。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。若不指定该参数,则默认查询筛选条件下所有机型。

    类型:String

    必选:否


  • instance-charge-type

  • 按照【实例计费模式】进行过滤。(PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费 )

    类型:String

    必选:否


  • sort-keys

  • 按关键字进行排序,格式为排序字段加排序方式,中间用冒号分隔。 例如: 按cpu数逆序排序 "cpu:desc", 按mem大小顺序排序 "mem:asc"

    类型:String

    必选:否


    每次请求的Filters的上限为10,Filter.Values的上限为100。

    3. 输出参数

    参数名称 类型 描述
    InstanceTypeQuotaSet Array of InstanceTypeQuotaItem 可用区机型配置列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取可用区的机型配置信息列表

    通过可用区和付费类型作为过滤条件, 查询配置信息列表。

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeZoneInstanceConfigInfos
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "POSTPAID_BY_HOUR"
                ],
                "Name": "instance-charge-type"
            },
            {
                "Values": [
                    "ap-guangzhou-2"
                ],
                "Name": "zone"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "InstanceTypeQuotaSet": [
                {
                    "Status": "SELL",
                    "Zone": "ap-guangzhou-2",
                    "NetworkCard": 0,
                    "Price": {
                        "DiscountPrice": 59,
                        "OriginalPriceThreeYear": 0,
                        "DiscountOneYear": 0,
                        "UnitPrice": 0,
                        "UnitPriceThirdStep": 0,
                        "OriginalPriceFiveYear": 0,
                        "Discount": 0,
                        "DiscountFiveYear": 0,
                        "UnitPriceDiscountThirdStep": 0,
                        "UnitPriceSecondStep": 0,
                        "OriginalPrice": 59,
                        "DiscountThreeYear": 0,
                        "UnitPriceDiscountSecondStep": 0,
                        "UnitPriceDiscount": 0,
                        "DiscountPriceFiveYear": 0,
                        "OriginalPriceOneYear": 708,
                        "ChargeUnit": "HOUR",
                        "DiscountPriceThreeYear": 0,
                        "DiscountPriceOneYear": 587.64
                    },
                    "InstanceFamily": "S2",
                    "Externals": {},
                    "InstanceType": "S2.SMALL1",
                    "TypeName": "Standard S2",
                    "InstanceChargeType": "POSTPAID_BY_HOUR",
                    "Memory": 1,
                    "LocalDiskTypeList": [],
                    "Cpu": 1,
                    "SoldOutReason": "",
                    "StorageBlockAmount": 0,
                    "CpuType": "Intel Xeon E5-2680 v4",
                    "InstancePps": 20,
                    "InstanceBandwidth": 1.5,
                    "Gpu": 0,
                    "GpuCount": 0,
                    "Fpga": 0,
                    "Remark": "",
                    "Frequency": "2.4GHz",
                    "StatusCategory": "EnoughStock"
                }
            ],
            "RequestId": "c28559ca-d3cf-40f0-9664-2ab303484efa"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameterValue.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
    InvalidParameterValue.InvalidAppIdFormat 无效的appid。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    InvalidRegion.NotFound 未找到该区域。
    InvalidZone.MismatchRegion 指定的zone不存在。
    ResourceInsufficient.AvailabilityZoneSoldOut 该可用区已售罄
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.UnsupportedPool 指定的Pool非法。