You can call this operation to query instance families provided by ECS.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceTypeFamilies

The operation that you want to perform. If you use a custom HTTP URL or HTTPS URL to make an API request, you must specify the Action parameter. Set the value to DescribeInstanceTypeFamilies.

RegionId String Yes cn-hangzhou

The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

Generation String No ecs-3

The generation of the instance family. For more information, see Instance families. Valid values:

  • ecs-1: Generation I, which consists of the earliest and cost-effective instance types.
  • ecs-2: Generation II, which features upgraded software and hardware and higher performance than Generation I.
  • ecs-3: Generation III, which consists of high-performance instance types and is suitable for different business scenarios.
  • ecs-4: Generation IV, which consists of the low-latency instance types that can meet a wide variety of business requirements.
  • ecs-5: Generation V, which consists of enterprise-level instance types (such as g6, c6, and r6), Bare Metal Instance types (such as ebmg6, ebmg6e, and ebmc6), and storage enhanced instance types (such as g6e), and delivers quick response and higher performance.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

InstanceTypeFamilies Array

An array consisting of InstanceTypeFamily data.

InstanceTypeFamilyId String ecs.g6

The ID of the instance family.

Generation String ecs-5

The generation of the instance family.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeInstanceTypeFamilies
&RegionId=cn-hangzhou
&Generation=ecs-5
&<Common request parameters>

Sample success responses

XML format

<DescribeInstanceTypeFamiliesResponse>
      <InstanceTypeFamilies>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.g6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.ebmg6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.ebmg6e</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.g6e</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.c6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.r6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.t6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.hfc6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.hfg6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.hfr6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.ebmc6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
            <InstanceTypeFamily>
                  <InstanceTypeFamilyId>ecs.ebmr6</InstanceTypeFamilyId>
                  <Generation>ecs-5</Generation>
            </InstanceTypeFamily>
      </InstanceTypeFamilies>
      <RequestId>A66D039A-EC35-4130-B0D1-E9873C0742D2</RequestId>
</DescribeInstanceTypeFamiliesResponse>

JSON format

{
    "InstanceTypeFamilies": {
        "InstanceTypeFamily": [
            {
                "InstanceTypeFamilyId": "ecs.g6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.ebmg6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.ebmg6e",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.g6e",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.c6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.r6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.t6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.hfc6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.hfg6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.hfr6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.ebmc6",
                "Generation": "ecs-5"
            },
            {
                "InstanceTypeFamilyId": "ecs.ebmr6",
                "Generation": "ecs-5"
            }
        ]
    },
    "RequestId": "A66D039A-EC35-4130-B0D1-E9873C0742D2"
}

Error codes

For a list of error codes, visit the API Error Center.