查询实例机型列表

最近更新时间:2018-08-17 17:02:38

1. 接口描述

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

本接口 (DescribeInstanceTypeConfigs) 用于查询实例机型配置。

  • 可以根据zoneinstance-family来查询实例机型配置。过滤条件详见过滤器Filter
  • 如果参数为空,返回指定地域的所有实例机型配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceTypeConfigs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
Filters.N Array of Filter 过滤条件。
  • zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • instance-family - String - 是否必填:否 -(过滤条件)按照实例机型系列过滤。实例机型系列形如:S1、I1、M1等。

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

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter参数值数量超过限制。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidZone.MismatchRegion 指定的zone不存在。

    5. 示例

    示例1 查询实例机型列表

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeInstanceTypeConfigs
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-2
    &Filters.1.Name=instance-family
    &Filters.1.Values.0=I1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceTypeConfigSet": [
          {
            "CPU": 2,
            "FPGA": 0,
            "GPU": 0,
            "InstanceFamily": "I1",
            "InstanceType": "I1.MEDIUM4",
            "Memory": 4,
            "Zone": "ap-guangzhou-2"
          },
          {
            "CPU": 2,
            "FPGA": 0,
            "GPU": 0,
            "InstanceFamily": "I1",
            "InstanceType": "I1.MEDIUM8",
            "Memory": 8,
            "Zone": "ap-guangzhou-2"
          },
          {
            "CPU": 2,
            "FPGA": 0,
            "GPU": 0,
            "InstanceFamily": "I1",
            "InstanceType": "I1.MEDIUM16",
            "Memory": 16,
            "Zone": "ap-guangzhou-2"
          },
          {
            "CPU": 4,
            "FPGA": 0,
            "GPU": 0,
            "InstanceFamily": "I1",
            "InstanceType": "I1.LARGE8",
            "Memory": 8,
            "Zone": "ap-guangzhou-2"
          }
        ],
        "RequestId": "2f1fd71e-95ab-4f10-8adb-895e99d33ff5"
      }
    }

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。