查询实例机型列表

最近更新时间:2024-03-12 01:19:26

我的收藏

1. 接口描述

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

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceTypeConfigs。
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

  • 按照【实例类型】进行过滤。实例类型形如:S5.12XLARGE128、S5.12XLARGE96等。具体取值参见实例规格描述。

    类型:String

    必选:否


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

    3. 输出参数

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

    4. 示例

    示例1 查询实例机型列表

    查询广州二区中实例机型系列为I1的机型列表

    输入示例

    GET 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": [
                {
                    "Zone": "ap-guangzhou-2",
                    "InstanceFamily": "I1",
                    "InstanceType": "I1.MEDIUM4",
                    "CPU": 2,
                    "GPU": 0,
                    "FPGA": 0,
                    "Memory": 4,
                    "GpuCount": 0
                },
                {
                    "Zone": "ap-guangzhou-2",
                    "InstanceFamily": "I1",
                    "InstanceType": "I1.MEDIUM8",
                    "CPU": 2,
                    "GPU": 0,
                    "FPGA": 0,
                    "Memory": 8,
                    "GpuCount": 0
                },
                {
                    "Zone": "ap-guangzhou-2",
                    "InstanceFamily": "I1",
                    "InstanceType": "I1.MEDIUM16",
                    "CPU": 2,
                    "GPU": 0,
                    "FPGA": 0,
                    "Memory": 16,
                    "GpuCount": 0
                },
                {
                    "Zone": "ap-guangzhou-2",
                    "InstanceFamily": "I1",
                    "InstanceType": "I1.LARGE8",
                    "CPU": 4,
                    "GPU": 0,
                    "FPGA": 0,
                    "Memory": 8,
                    "GpuCount": 0
                }
            ],
            "RequestId": "2f1fd71e-95ab-4f10-8adb-895e99d33ff5"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    InvalidZone.MismatchRegion 指定的zone不存在。
    ResourcesSoldOut.SpecifiedInstanceType 指定的实例类型已售罄。
    UnsupportedOperation 操作不支持。