DescribePatternTypes - Auto Scaling - Alibaba Cloud Documentation Center

Queries instance types. When you call the DescribePatternTypes operation, you can specify attributes to obtain the instance types that meet your business requirements. The attributes include the vSwitch ID, number of vCPUs, memory size, instance family, and maximum acceptable price of each instance type.

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	DescribePatternTypes	The operation that you want to perform. Set the value to DescribePatternTypes.
RegionId	String	Yes	cn-hangzhou	The region ID.
VSwitchId.N	String	No	vsw-bp14zolna43z266bq****	The vSwitch ID.
ZoneId.N	String	No	cn-hangzhou-g	The zone ID.
SpotStrategy	String	No	NoSpot	The preemption policy that you want to apply to pay-as-you-go or preemptible instances. Valid values: NoSpot: The instances are created as regular pay-as-you-go instances. SpotWithPriceLimit: The instances are preemptible instances that have a user-defined maximum hourly price. SpotAsPriceGo: The instances are created as preemptible instances for which the market price at the time of purchase is automatically used as the bidding price. Default value: NoSpot.
Cores	Integer	No	2	The number of vCPUs per instance type.
Memory	Float	No	4	The memory size per instance type. Unit: GiB.
MaxPrice	Float	No	2	The maximum hourly price of pay-as-you-go or preemptible instances.
InstanceFamilyLevel	String	No	EnterpriseLevel	The level of the instance family. Valid values: EntryLevel: entry-level (shared instance types). Instance types of this level are the most cost-effective but may not ensure consistent computing performance. Instance types of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see Shared instance families. EnterpriseLevel: enterprise-level. Instance types of this level provide stable performance and dedicated resources and are suitable for business scenarios that require high stability. For more information, see Overview of instance families. CreditEntryLevel: credit entry-level (burstable instance types). CPU credits are used to ensure computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see Overview of burstable instances.
ExcludedInstanceType.N	String	No	ecs.c6.xlarge	The instance type that you want to exclude. You can use an asterisk () as the wildcard character to exclude an instance type or instance family. Examples: ecs.c6.large: excludes the ecs.c6.large instance type. ecs.c6.: excludes the c6 instance family. Note If you want to exclude multiple instance types, separate the instance types with forward slashes (/). Example: `ecs.n1.small/ecs.n1./7*`.
Architecture.N	String	No	X86	The architecture type of the instance type. Valid values: X86: x86. Heterogeneous: heterogeneous computing, such as GPU-accelerated or FPGA-accelerated. BareMetal: ECS Bare Metal Instance. Arm: Arm. By default, all values are selected.
BurstablePerformance	String	No	Include	Specifies whether to include burstable instance types. Valid values: Exclude: excludes burstable instance types. Include: includes burstable instance types. Required: includes only burstable instance types. Default value: Include.
CoresList.N	Integer	No	2	The number of vCPUs per instance type. You can specify multiple numbers of vCPUs.
MemoryList.N	Float	No	4	The memory size per instance type. Unit: GiB. You can specify multiple memory sizes.
ChannelId	Long	No	79425074	The channel ID. Note This parameter is in invitational preview and is not publicly available.
InstanceTypeFamilies.N	String	No	ecs.g6	The instance family N that you want to query. Valid values of N: 1 to 10.
MinimumCpuCoreCount	Integer	No	2	The minimum number of vCPUs per instance type.
MaximumCpuCoreCount	Integer	No	4	The maximum number of vCPUs per instance type.
GpuSpecs.N	String	No	NVIDIA V100	The GPU model.
InstanceCategories.N	String	No	Compute-optimized with GPU	The category N of the instance type. Valid values: General-purpose: general-purpose instance type. Compute-optimized: compute-optimized instance type. Memory-optimized: memory-optimized instance type. Big data: big data instance type. Local SSDs: instance type that uses local SSDs. High Clock Speed: instance type that has a high clock speed. Enhanced: enhanced instance type. Shared: shared instance type. Compute-optimized with GPU: GPU-accelerated compute-optimized instance type. Visual Compute-optimized: visual compute-optimized instance type. Heterogeneous Service: heterogeneous service instance type. Compute-optimized with FPGA: FPGA-accelerated compute-optimized instance type. Compute-optimized with NPU: NPU-accelerated compute-optimized instance type. ECS Bare Metal: ECS Bare Metal Instance type. High Performance Compute: HPC-optimized instance type.
CpuArchitectures.N	String	No	X86	The CPU architecture N of the instance type. Valid values: Note Valid values of N: 1 and 2. x86 Arm
PhysicalProcessorModels.N	String	No	Intel Xeon(Ice Lake) Platinum 8369B	The processor model N of ECS instances. Valid values of N: 1 to 10.
MinimumEniQuantity	Integer	No	2	The minimum number of elastic network interfaces (ENIs) per instance.
MinimumEniPrivateIpAddressQuantity	Integer	No	2	The minimum number of IPv4 addresses per ENI.
MinimumEniIpv6AddressQuantity	Integer	No	1	The minimum number of IPv6 addresses per ENI.
MinimumInitialCredit	Integer	No	12	The initial vCPU credits of each t5 or t6 burstable instance.
MinimumBaselineCredit	Integer	No	12	The minimum baseline vCPU computing performance (overall baseline performance of all vCPUs) of each t5 or t6 burstable instance.
MinimumMemorySize	Float	No	4	The minimum memory size per instance. Unit: GiB.
MaximumMemorySize	Float	No	4	The maximum memory size per instance. Unit: GiB.
MinimumGpuAmount	Integer	No	2	The minimum number of GPUs per instance. The value must be a positive integer.
MaximumGpuAmount	Integer	No	2	The maximum number of GPUs per instance. The value must be a positive integer.

Response parameters

Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	The request ID.
PatternTypes	Array of PatternType		The instance types that meet the specified requirements.
InstanceType	String	ecs.c7.xlarge	The name of the instance type.
InstanceFamilyLevel	String	EnterpriseLevel	The level of the instance family. Valid values: EntryLevel: entry-level (shared instance types). Instance types of this level are the most cost-effective but may not ensure consistent computing performance. Instance types of this level are suitable for business scenarios in which the CPU utilization is low. For more information, see Shared instance families. EnterpriseLevel: enterprise-level. Instance types of this level provide stable performance and dedicated resources and are suitable for business scenarios that require high stability. For more information, see Overview of instance families. CreditEntryLevel: credit entry-level (burstable instance types). CPU credits are used to ensure computing performance. Instance types of this level are suitable for scenarios in which the CPU utilization is low but may fluctuate in specific cases. For more information, see Overview of burstable instances.
InstanceTypeFamily	String	ecs.c7	The instance family.
Cores	Integer	4	The number of vCPUs per instance type.
Memory	Float	8	The memory size per instance type. Unit: GiB.

Examples

Sample requests

http(s)://ess.aliyuncs.com/?Action=DescribeAlarms
&RegionId=cn-hangzhou
&VSwitchId=["vsw-bp14zolna43z266bq****"]
&ZoneId=["cn-hangzhou-g"]
&SpotStrategy=NoSpot
&Cores=2
&Memory=4.0
&MaxPrice=2.0
&InstanceFamilyLevel=EnterpriseLevel
&ExcludedInstanceType=["ecs.c6.xlarge"]
&Architecture=["X86"]
&BurstablePerformance=Include
&CoresList=[2]
&MemoryList=[4.0]
&ChannelId=79425074
&InstanceTypeFamilies=["ecs.g6"]
&MinimumCpuCoreCount=2
&MaximumCpuCoreCount=4
&GpuSpecs=["NVIDIA V100"]
&InstanceCategories=["Compute-optimized with GPU"]
&CpuArchitectures=["X86"]
&PhysicalProcessorModels=["Intel Xeon(Ice Lake) Platinum 8369B"]
&MinimumEniQuantity=2
&MinimumEniPrivateIpAddressQuantity=2
&MinimumEniIpv6AddressQuantity=1
&MinimumInitialCredit=12
&MinimumBaselineCredit=12
&MinimumMemorySize=4.0
&MaximumMemorySize=4.0
&MinimumGpuAmount=2
&MaximumGpuAmount=2
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePatternTypesResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PatternTypes>
        <InstanceType>ecs.c7.xlarge</InstanceType>
        <InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>
        <InstanceTypeFamily>ecs.c7</InstanceTypeFamily>
        <Cores>4</Cores>
        <Memory>8</Memory>
    </PatternTypes>
</DescribePatternTypesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PatternTypes" : [ {
    "InstanceType" : "ecs.c7.xlarge",
    "InstanceFamilyLevel" : "EnterpriseLevel",
    "InstanceTypeFamily" : "ecs.c7",
    "Cores" : 4,
    "Memory" : 8
  } ]
}

Error codes

For a list of error codes, see Service error codes.