DescribePatternTypes-Auto Scaling(ESS)-阿里云帮助中心

When configuring scaling configurations using the instance attribute-based method, call the DescribePatternTypes API to filter eligible instance types based on specified instance attributes such as the number of vCPU cores, memory size, instance family level, and the maximum acceptable price.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
VSwitchId	array	No	The list of vSwitch IDs.
	string	No	The ID of the vSwitch.	vsw-bp14zolna43z266bq****
ZoneId	array	No	The list of zone IDs. This parameter is invalid when vSwitch IDs are specified.
	string	No	The zone ID.	cn-hangzhou-g
SpotStrategy	string	No	The bidding policy for pay-as-you-go instances. Valid values: NoSpot: a regular pay-as-you-go instance. SpotWithPriceLimit: a preemptible instance with a user-defined maximum hourly price. SpotAsPriceGo: a preemptible instance for which the system automatically bids with the current market price. Default value: NoSpot.	NoSpot
Cores	integer	No	The number of vCPU cores of the instance type.	2
Memory	number	No	The memory size of the instance type. Unit: GiB.	4
MaxPrice	number	No	The maximum acceptable hourly price for pay-as-you-go or preemptible instances.	2
InstanceFamilyLevel	string	No	The level of the instance family. Valid values: EntryLevel: entry-level, shared instance type. Lower cost but no guaranteed stable computing performance. Suitable for scenarios with generally low CPU utilization. For more information, see Shared instance families. EnterpriseLevel: enterprise-level. Stable performance with dedicated resources. Suitable for scenarios that require high stability. For more information, see Instance families. CreditEntryLevel: credit-based entry-level, burstable performance instance. Uses CPU credits to ensure computing performance. Suitable for scenarios with normally low CPU utilization and occasional spikes. For more information, see Burstable performance instances.	EnterpriseLevel
ExcludedInstanceType	array	No	The instance types to exclude. You can use wildcard characters () to exclude a single instance type or an entire instance family. Examples: ecs.c6.large: excludes the ecs.c6.large instance type. ecs.c6.: excludes all instance types in the c6 instance family. Note To exclude multiple instance types, separate them with forward slashes (/). Example: `ecs.n1.small/ecs.n1./7*`.
	string	No	The instance types to exclude. You can use wildcard characters () to exclude a single instance type or an entire instance family. Examples: ecs.c6.large: excludes the ecs.c6.large instance type. ecs.c6.: excludes all instance types in the c6 instance family. Note To exclude multiple instance types, separate them with forward slashes (/). Example: `ecs.n1.small/ecs.n1./7*`.	ecs.c6.xlarge
Architecture	array	No	The architecture types of the instance type. Valid values: X86: x86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA. BareMental: ECS Bare Metal Instance. Arm: Arm computing. Default value: all architecture types.
	string	No	The architecture types of the instance type. Valid values: X86: x86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA. BareMental: ECS Bare Metal Instance. Arm: Arm computing. Default value: all architecture types.	X86
BurstablePerformance	string	No	Specifies whether to include burstable performance instance types. Valid values: Exclude: excludes burstable performance instance types. Include: includes burstable performance instance types. Required: includes only burstable performance instance types. Default value: Include.	Include
CoresList	array	No	The number of vCPU cores of the instance type. You can specify multiple values.
	integer	No	The number of vCPU cores of the instance type. You can specify multiple values.	2
MemoryList	array	No	The memory size of the instance type. Unit: GiB. You can specify multiple values.
	number	No	The memory size of the instance type. Unit: GiB. You can specify multiple values.	4
ChannelId	integer	No	The channel ID. Note This parameter is not publicly available (internal reserved parameter only).	79425074
InstanceTypeFamilies	array	No	The instance type families to query. N indicates that you can specify multiple instance type families. Valid values of N: 1 to 10.
	string	No	The instance type families to query. N indicates that you can specify multiple instance type families. Valid values of N: 1 to 10.	ecs.g6
MinimumCpuCoreCount	integer	No	The minimum number of vCPU cores of the instance type.	2
MaximumCpuCoreCount	integer	No	The maximum number of vCPU cores of the instance type.	4
GpuSpecs	array	No	The GPU types.
	string	No	The GPU type.	NVIDIA V100
InstanceCategories	array	No	The instance type categories. Valid values: General-purpose: general-purpose type. Compute-optimized: compute-optimized type. Memory-optimized: memory-optimized type. Big data: big data type. Local SSDs: local SSD type. High Clock Speed: high clock speed type. Enhanced: enhanced type. Shared: shared type. Compute-optimized with GPU: GPU compute-optimized type. Visual Compute-optimized: visual compute-optimized type. Heterogeneous Service: heterogeneous service type. Compute-optimized with FPGA: FPGA compute-optimized type. Compute-optimized with NPU: NPU compute-optimized type. ECS Bare Metal: ECS Bare Metal Instance. High Performance Compute: high performance computing type.
	string	No	The instance type categories. Valid values: General-purpose: general-purpose type. Compute-optimized: compute-optimized type. Memory-optimized: memory-optimized type. Big data: big data type. Local SSDs: local SSD type. High Clock Speed: high clock speed type. Enhanced: enhanced type. Shared: shared type. Compute-optimized with GPU: GPU compute-optimized type. Visual Compute-optimized: visual compute-optimized type. Heterogeneous Service: heterogeneous service type. Compute-optimized with FPGA: FPGA compute-optimized type. Compute-optimized with NPU: NPU compute-optimized type. ECS Bare Metal: ECS Bare Metal Instance. High Performance Compute: high performance computing type.	Compute-optimized with GPU
CpuArchitectures	array	No	The CPU architectures of the instance type.
	string	No	The CPU architecture of the instance type. Valid values: Note N indicates that you can specify multiple CPU architectures. Valid values of N: 1 to 2. X86. ARM.	X86
PhysicalProcessorModels	array	No	The processor models of the instance. N indicates that you can specify multiple processor models. Valid values of N: 1 to 10.
	string	No	The processor models of the instance. N indicates that you can specify multiple processor models. Valid values of N: 1 to 10.	Intel Xeon(Ice Lake) Platinum 8369B
MinimumEniQuantity	integer	No	The minimum number of elastic network interfaces (ENIs) supported by the instance.	2
MinimumEniPrivateIpAddressQuantity	integer	No	The minimum number of IPv4 addresses per ENI for the instance.	2
MinimumEniIpv6AddressQuantity	integer	No	The minimum number of IPv6 addresses per ENI for the instance.	1
MinimumInitialCredit	integer	No	The minimum initial vCPU credits for burstable performance instances t5 and t6.	12
MinimumBaselineCredit	integer	No	The minimum baseline vCPU computing performance (sum of all vCPUs) for burstable performance instances t5 and t6.	12
MinimumMemorySize	number	No	The minimum memory size of the instance. Unit: GiB.	4
MaximumMemorySize	number	No	The maximum memory size of the instance. Unit: GiB.	4
MinimumGpuAmount	integer	No	The minimum number of GPUs of the instance. Valid values: positive integers.	2
MaximumGpuAmount	integer	No	The maximum number of GPUs of the instance. Valid values: positive integers.	2

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PatternTypes	array<object>	The eligible instance types.
	object	The eligible instance types.
InstanceType	string	The name of the instance type.	ecs.c7.xlarge
InstanceFamilyLevel	string	The level of the instance family. Valid values: EntryLevel: entry-level, shared instance type. Lower cost but no guaranteed stable computing performance. Suitable for scenarios with generally low CPU utilization. For more information, see Shared instance families. EnterpriseLevel: enterprise-level. Stable performance with dedicated resources. Suitable for scenarios that require high stability. For more information, see Instance families. CreditEntryLevel: credit-based entry-level, burstable performance instance. Uses CPU credits to ensure computing performance. Suitable for scenarios with normally low CPU utilization and occasional spikes. For more information, see Burstable performance instances.	EnterpriseLevel
InstanceTypeFamily	string	The instance type family.	ecs.c7
Cores	integer	The number of vCPU cores of the instance type.	4
Memory	number	The memory size of the instance type. Unit: GiB.	8

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.