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

文档中心

立即注册

导航

云服务器

DescribeInstanceTypeFamilies - 查询实例规格族列表

最近更新时间：2024.05.21 10:23:56首次发布时间：2022.07.01 09:21:49

调用 DescribeInstanceTypeFamilies 查询云服务器提供的实例规格族信息。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstanceTypeFamilies	要执行的操作，取值：DescribeInstanceTypeFamilies。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ZoneId	String	否	cn-beijing-a	实例所在可用区ID。您可以调用DescribeZones查询一个地域下的可用区信息。
Generation	String	否	ecs-1	实例规格族代系，取值： ecs-1：一代实例规格 ecs-2：二代实例规格 ecs-3：三代实例规格更多详情，请参见实例选型最佳实践和实例规格介绍。

返回参数

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

参数	类型	示例值	描述
InstanceTypeFamilies	Array of InstanceTypeFamiliesForDescribeInstanceTypeFamilies	--	实例规格族信息。

请求示例

GET /?Action=DescribeInstanceTypeFamilies&Version=2020-04-01&ZoneId=cn-beijing-a HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeInstanceTypeFamilies",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceTypeFamilies": [
            {
                "InstanceTypeFamily": "ecs.c1ie",
                "ZoneIds": [
                    "cn-beijing-a"
                ],
                "Generation": "ecs-1"
            },
            {
                "InstanceTypeFamily": "ecs.g2i",
                "ZoneIds": [
                    "cn-beijing-a"
                ],
                "Generation": "ecs-2"
            }
          ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
404	InvalidZone.NotFound	The specified zone does not exist.	指定的可用区不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。