操作指南

最佳实践

运维指南

API 文档

获取可用区机型配置信息

最近更新时间:2020-08-04 08:09:22

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 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等。

    类型:Integer

    必选:否


  • instance-type

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

    类型:String

    必选:否


  • instance-charge-type

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

    类型:String

    必选:否


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

    3. 输出参数

    参数名称 类型 描述
    InstanceTypeQuotaSet Array of InstanceTypeQuotaItem 可用区机型配置列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

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

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=DescribeZoneInstanceConfigInfos
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-2
    &Filters.1.Name=instance-charge-type
    &Filters.1.Values.0=POSTPAID_BY_HOUR
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceTypeQuotaSet": [
          {
            "Status": "SELL",
            "Zone": "ap-guangzhou-2",
            "NetworkCard": 0,
            "Price": {
              "UnitPrice": 0.15,
              "DiscountThirdStep": "100.000000",
              "UnitPriceThirdStep": 0.05,
              "DiscountSecondStep": "100.000000",
              "Discount": "100.000000",
              "UnitPriceDiscountThirdStep": 0.05,
              "UnitPriceSecondStep": 0.07,
              "UnitPriceDiscount": 0.15,
              "UnitPriceDiscountSecondStep": 0.07,
              "ChargeUnit": "HOUR"
            },
            "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,
            "Fpga": 0,
            "Remark": ""
          }
        ],
        "RequestId": "c28559ca-d3cf-40f0-9664-2ab303484efa"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidFilter 无效的过滤器。
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidRegion.NotFound 未找到该区域。
    InvalidZone.MismatchRegion 指定的zone不存在。
    目录