DescribeInstanceTypes - 查询实例规格列表--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeInstanceTypes - 查询实例规格列表

最近更新时间：2025.03.18 10:48:45首次发布时间：2021.12.29 11:18:50

调用 DescribeInstanceTypes 接口查询云服务器提供的所有实例规格的信息，也可以查询指定实例规格的信息。

使用说明

该接口仅查询实例规格的配置和性能信息，如果您需要查询具体可用区下可购买的实例规格，请使用DescribeAvailableResource。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstanceTypes	要执行的操作，取值：DescribeInstanceTypes。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ImageId	String	否	image-ydam1k535clzp*****	镜像ID，查询该镜像可创建的实例规格。
InstanceTypeIds.N	Array of String	否	InstanceTypeIds.1=ecs.g3i.large&InstanceTypeIds.2=ecs.g1ve.8xlarge	指定查询的实例规格。取值请参见实例规格介绍。参数 - N：表示实例规格的序号，取值范围：1～100。N大于100时，仅前100个生效。多个InstanceTypeId 之间用&分隔。说明不传则默认查询所有实例规格的信息。
MaxResults	Integer	否	10	分页查询时设置的每页行数。最大值：1000 最小值：1 默认值：10
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstanceTypes	Array of Object	--	符合条件的实例规格信息。
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	本次调用返回的查询凭证值，返回为空表示没有下一页。

请求示例

GET /?Action=DescribeInstanceTypes&Version=2020-04-01&InstanceTypeIds.1=ecs.g3i.large HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2021110417394001022514606307D7****",
    "Action": "DescribeInstanceTypes",
    "Version": "2020-04-01",
    "Service": "ecs",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceTypes": [
{      
        "InstanceTypeFamily": "ecs.g3i",
        "Gpu": null,
        "Rdma": null,
        "BaselineCredit": 0,
        "InitialCredit": 0,
        "InstanceTypeId": "ecs.g3i.large",
        "IsSupportEsi": "true",
        "IsSupportAffinityGroup": false,
        "AffinityGroupSizes": [],
        "Processor": {
          "Cpus": 2,
          "Model": "Intel Xeon(Ice Lake) Platinum 8336C",
          "BaseFrequency": 2.3,
          "TurboFrequency": 3
        },
        "Memory": {
          "Size": 8192,
          "EncryptedSize": 0
        },
        "Network": {
          "MaximumNetworkInterfaces": 3,
          "MaximumPrivateIpv4AddressesPerNetworkInterface": 6,
          "MaximumQueuesPerNetworkInterface": 2,
          "BaselineBandwidthMbps": 2000,
          "MaximumBandwidthMbps": 2000,
          "MaximumThroughputKpps": 500
        },
        "LocalVolumes": [],
        "Volume": {
          "SupportedVolumeTypes": [
            "ESSD_FlexPL",
            "ESSD_PL0"
          ],
          "MaximumCount": 16
        }
      }
    ],
    "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
404	InvalidActionOrVersion	Could not find operation %s for version %s.	请求接口不存在。
404	InvalidImage.NotFound	The specified image does not exist.	指定的镜像不存在。
429	FlowLimitExceeded	You've reach the limit on request rate of resources.	您已超过资源请求限速。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。