文档平台 API 中心 云服务器 实例相关接口 获取可用区机型配置信息

获取可用区机型配置信息

最近更新时间:2018-12-06 21:42:20

1. 接口描述

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

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

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

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

2. 输入参数

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

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

  • zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。


  • instance-family String - 是否必填:否 -(过滤条件)按照机型系列过滤。按照实例机型系列过滤。实例机型系列形如:S1、I1、M1等。


  • instance-type - String - 是否必填:否 - (过滤条件)按照机型过滤。按照实例机型过滤。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 DescribeInstanceTypeConfigs 来获得最新的规格表或参见实例类型描述。若不指定该参数,则默认机型为S1.SMALL1。


  • instance-charge-type - String - 是否必填:否 -(过滤条件)按照实例计费模式过滤。 (PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费 | CDHPAID:表示CDH付费,即只对CDH计费,不对CDH上的实例计费。 )
  • 3. 输出参数

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

    4. 示例

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

    输入示例

    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": [
          {
            "Cpu": 2,
            "Externals": {},
            "InstanceChargeType": "POSTPAID_BY_HOUR",
            "InstanceFamily": "S2",
            "InstanceType": "S2.MEDIUM4",
            "LocalDiskTypeList": [
              {
                "MaxSize": 50,
                "MinSize": 50,
                "PartitionType": "ROOT",
                "Type": "LOCAL_BASIC"
              },
              {
                "MaxSize": 500,
                "MinSize": 0,
                "PartitionType": "DATA",
                "Type": "LOCAL_BASIC"
              }
            ],
            "Memory": 4,
            "NetworkCard": 0,
            "Price": {
              "ChargeUnit": "HOUR",
              "UnitPrice": 0.64
            },
            "Status": "SELL",
            "TypeName": "标准型S2",
            "Zone": "ap-guangzhou-2"
          }
        ],
        "RequestId": "c28559ca-d3cf-40f0-9664-2ab303484efa"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidRegion.NotFound 未找到该区域。
    InvalidZone.MismatchRegion 指定的zone不存在。

    如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >