云主机

产品文档

云主机

帮助中心 > OpenAPI & SDK > 云主机 > describeInstanceTypes

describeInstanceTypes

描述

查询实例规格列表。

详细操作说明请参考帮助文档:实例规格类型

接口说明

  • 调用该接口可查询全量实例规格信息。
  • 可查询实例规格的CPU、内存大小、可绑定的弹性网卡数量、可挂载的云硬盘数量,是否售卖等信息。
  • GPU 或 本地存储型的规格可查询 GPU型号、GPU卡数量、本地盘数量。
  • 尽量使用过滤器查询关心的实例规格,并适当缓存这些信息。否则全量查询可能响应较慢。

请求方式

GET

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/instanceTypes

名称 类型 是否必需 示例值 描述
regionId String cn-north-1 地域ID。

请求参数

名称 类型 是否必选 示例值 描述
serviceName String vm 产品线类型,可选值:
vm(默认值):云主机
nc:原生容器
filters Filter[ ] filters 中支持使用以下关键字进行过滤
instanceTypes: 实例规格,精确匹配,支持多个
az: 可用区,精确匹配,支持多个

Filter

名称 类型 是否必选 示例值 描述
name String instanceTypes 过滤条件的名称
operator String eq 过滤条件的操作符,默认eq
values String[ ] g.n2.xlarge 过滤条件的值

返回参数

名称 类型 示例值 描述
result Result 响应结果。
requestId String c2hmmaan8w06w19qcdfuic4w03f7ft2d 请求ID。

Result

名称 类型 示例值 描述
instanceTypes InstanceType[ ] 实例规格详情列表。
specificInstanceTypes InstanceType[ ] 参数已废弃,无须关注。
totalCount Integer 本次查询到的所有实例规格数量。

InstanceType

名称 类型 示例值 描述
family String g.n 实例规格族。
generation Integer 2 实例规格代数。
instanceType String g.n2.xlarge 实例规格。
cpu Integer 4 vcpu个数。
memoryMB Integer 8192 内存大小,单位GiB。
nicLimit Integer 4 支持绑定的弹性网卡数量,包括主网卡。
cloudDiskCountLimit Integer 8 支持挂载的云硬盘数量,包括云盘系统盘。
desc String 实例规格描述。
state InstanceTypeState[ ] 实例规格售卖状态。已售罄的实例规格无法使用。
gpu Gpu GPU配置,针对GPU类型的实例规格有效。
localDisks LocalDisk[ ] 本地数据盘配置(缓存盘),针对GPU类型、或本地存储型的实例规格有效。

LocalDisk

名称 类型 示例值 描述
diskType String HDD 磁盘类型。可能值:NVMe SSD、HDD
diskSizeGB Integer 1117 磁盘大小,单位GiB。

Gpu

名称 类型 示例值 描述
model String Nvidia Tesla P40 GPU卡型号。
number Integer 4 GPU卡数量。

InstanceTypeState

名称 类型 示例值 描述
az String cn-north-1b 可用区。
inStock Boolean True 售卖状态,true:可售卖、false:已售罄不可用。

请求示例

GET

/v1/regions/cn-north-1/instanceTypes?filters.1.name=instanceTypes&filters.1.values.1=g.n2.medium&filters.1.values.2=p.n1p4c.2xlarge

返回示例

{
    "requestId": "f9bcb6d3ed288538b74494e48af3c5fe", 
    "result": {
        "instanceTypes": [
            {
                "cloudDiskCountLimit": 8, 
                "cpu": 1, 
                "desc": "", 
                "family": "g.n", 
                "generation": 2, 
                "instanceType": "g.n2.medium", 
                "memoryMB": 4096, 
                "nicLimit": 2, 
                "state": [
                    {
                        "az": "cn-north-1c", 
                        "inStock": true
                    }, 
                    {
                        "az": "cn-north-1a", 
                        "inStock": true
                    }, 
                    {
                        "az": "cn-north-1b", 
                        "inStock": true
                    }
                ]
            }, 
            {
                "cloudDiskCountLimit": 8, 
                "cpu": 8, 
                "desc": "", 
                "family": "p.n", 
                "generation": 1, 
                "gpu": {
                    "model": "Nvidia Tesla P4", 
                    "number": 1
                }, 
                "instanceType": "p.n1p4c.2xlarge", 
                "memoryMB": 26624, 
                "nicLimit": 4, 
                "state": [
                    {
                        "az": "cn-north-1c", 
                        "inStock": true
                    }, 
                    {
                        "az": "cn-north-1a", 
                        "inStock": false
                    }, 
                    {
                        "az": "cn-north-1b", 
                        "inStock": false
                    }
                ]
            }
        ], 
        "totalCount": 2
    }
}

返回码

HTTP状态码 错误码 描述 错误解析
200 OK
500 INTERNAL Internal server error 系统内部错误,请稍后重试。如果多次尝试失败,请提交工单。
500 UNKNOWN Unknown server error 服务暂时不可用,请稍后重试。如果多次尝试失败,请提交工单。
更新时间:2021-09-01 20:20:29
文档反馈 docs feedback