You need to enable JavaScript to run this app.
Elastic Compute Service

Elastic Compute Service

Copy page
Download PDF
Instances
DescribeInstanceTypeFamilies - Queries instance type families
Copy page
Download PDF
DescribeInstanceTypeFamilies - Queries instance type families
Call the DescribeInstanceTypeFamilies operation to query information about instance type families provided by ECS.​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
The table below lists only the request parameters specific to this operation and some common parameters. For more information, refer to Common parameters.​
Action string required Sample value: DescribeInstanceTypeFamilies​
The operation that you want to perform. Valid value: DescribeInstanceTypeFamilies.​
​
Version string required Sample value: 2020-04-01​
The version of the API. Valid value: 2020-04-01.​
​
Generation string Optional Sample value: ecs-1​
The generation of instance type families. Valid values:​
  • ecs-1: The 1st-generation instance type.​
  • ecs-2: The 2nd-generation instance type.​
  • ecs-3: The 3rd-generation instance type.​
For more information, see Best practices of instance selection and Instance types.​
​
ZoneId string Optional Sample value: cn-beijing-a​
The ID of the availability zone where the instance is located.​
You can call the DescribeZones operation to query the availability zones in the same region.​
​
​
​
Response parameters​
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.​
InstanceTypeFamilies object[] Sample value: --​
The information about instance type families.​
Generation string Sample value: ecs-2​
The generation of instance type families.​
​
InstanceTypeFamily string Sample value: ecs.g2i​
The instance type family.​
​
ZoneIds string[] Sample value: cn-beijing-a​
The availability zone ID where the instance type families are located.​
​
​
​
​
Sample request​
​
GET /?Action=DescribeInstanceTypeFamilies&Version=2020-04-01&ZoneId=cn-beijing-a HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​
​
Sample response​
​
{​
"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"​
}​
]​
}​
}​
​
Error codes​
The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.​
​
Status code​
Error codes​
Error message​
Description​
404​
InvalidZone.NotFound​
The specified zone does not exist.​
The specified availability zone does not exist.​
500​
InternalError​
An internal error has occurred.​
An internal error occurred. Try again. If multiple attempts fail, submit a ticket.​
​
​
Last updated: 2026.06.18 17:48:24