操作指南

最佳实践

故障处理

API 文档

查询实例机型列表

最近更新时间:2019-10-12 16:29:48

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口 (DescribeInstanceTypeConfigs) 用于查询实例机型配置。
接口请求域名:cvm.api.qcloud.com

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 类型 是否必选 描述
Version String 表示API版本号,主要用于标识请求的不同API版本。 本接口第一版本可传:2017-03-12。
Filters.N array of Filter objects 过滤条件,详见下表:实例过滤条件表。每次请求的Filters的上限为10,Filter.Values的上限为1。

实例过滤条件表

参数名称 类型 是否必选 描述
zone String (过滤条件)按照可用区过滤。
instance-family String (过滤条件)按照实例机型系列过滤。实例机型系列形如:S1I1M1等。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求ID。每次请求都会返回RequestId。当用户调用接口失败找后台研发人员处理时需提供该RequestId
InstanceTypeConfigSet array of InstanceTypeConfig objects 实例机型配置列表。

4. 错误码

以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见 公共错误码

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

5. 示例

输入

https://cvm.api.qcloud.com/v2/index.php?Action=DescribeInstanceTypeConfigs
&Version=2017-03-12
&Filters.1.Name=zone
&Filters.1.Values.1=ap-guangzhou-2
&Filters.1.Name=instance-family
&Filters.1.Values.1=I1
&<公共请求参数>

输出

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