All Products
Search
Document Center

Elastic Compute Service:DescribeInstanceTypeFamilies

Last Updated:May 14, 2024

Queries instance families provided by Elastic Compute Service (ECS).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
GenerationstringNo

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

  • ecs-1: Generation I, which consists of the earliest and cost-effective instance types
  • ecs-2: Generation II, which provides upgraded software and hardware and higher performance than Generation I
  • ecs-3: Generation III, which consists of high-performance instance families and is suitable for different business scenarios
  • ecs-4: Generation IV, which consists of enterprise-level instance families (such as g5, c5, and r5), ECS Bare Metal Instance families (such as ebmc5s, ebmg5s, and ebmr5s), and burstable instance families (such as t5) and can meet a wide variety of business requirements with lower latency
  • ecs-5: Generation V, which consists of enterprise-level instance families (such as g6, c6, and r6), ECS Bare Metal Instance families (such as ebmg6, ebmg6e, and ebmc6), and storage-enhanced instance families (such as g6e) and delivers quick response times and higher performance
  • ecs-6: Generation VI, which consists of enterprise-level instance families (such as hfc7, hfg7, and hfr7) and ECS Bare Metal Instance families (such as ebmhfg7) and is in invitational preview
ecs-5

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceTypeFamiliesobject []

The instance families.

Generationstring

The generation of the instance family.

ecs-5
InstanceTypeFamilyIdstring

The ID of the instance family.

ecs.g6

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "InstanceTypeFamilies": {
    "InstanceTypeFamily": [
      {
        "Generation": "ecs-5",
        "InstanceTypeFamilyId": "ecs.g6"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history