DescribePatternTypes - Auto Scaling - Alibaba Cloud Documentation Center

Queries instance types that match specified instance attributes, such as the number of vCPUs, memory size, instance family level, and maximum acceptable price, when you configure a scaling configuration by specifying instance attributes. This operation calls the DescribePatternTypes API operation.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:DescribePatternTypes

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
VSwitchId	array	No	The IDs of vSwitches.
	string	No	The ID of the vSwitch.	vsw-bp14zolna43z266bq****
ZoneId	array	No	The IDs of zones. This parameter is invalid if you specify vSwitch IDs.
	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 spot instance with a maximum price limit. SpotAsPriceGo: a spot instance for which the system automatically bids based on the current market price. Default value: NoSpot.	NoSpot
Cores	integer	No	The number of vCPUs of the instance type.	2
Memory	number	No	The memory size of the instance type. Unit: GiB.	4
MaxPrice	number	No	The maximum hourly price acceptable for pay-as-you-go or spot instances.	2
InstanceFamilyLevel	string	No	The instance family level. Valid values: EntryLevel: entry level, which refers to shared instance types. These instance types are more cost-effective but do not guarantee stable computing performance. They are suitable for scenarios in which CPU utilization is low. For more information, see Shared instance types. EnterpriseLevel: enterprise level. These instance types provide stable performance and dedicated resources. They are suitable for scenarios that require high stability. For more information, see Instance families. CreditEntryLevel: credit-based entry level, which refers to burstable instances. These instance types use CPU credits to ensure computing performance. They are suitable for scenarios in which CPU utilization is typically low with occasional bursts. For more information, see Burstable 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 type of the instance type. Valid values: X86: x86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA. BareMental: Elastic Compute Service Bare Metal Instance server. Arm: Arm computing. Default value: all architecture types.
	string	No	The architecture type of the instance type. Valid values: X86: x86 computing. Heterogeneous: heterogeneous computing, such as GPU or FPGA. BareMental: Elastic Compute Service Bare Metal Instance server. Arm: Arm computing. Default value: all architecture types.	X86
BurstablePerformance	string	No	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.	Include
CoresList	array	No	The number of vCPUs of the instance type. You can specify multiple values.
	integer	No	The number of vCPUs 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 reserved for internal use only.	79425074
InstanceTypeFamilies	array	No	The instance families to query. N specifies that you can set multiple instance families. Valid values of N: 1 to 10.
	string	No	The instance families to query. N specifies that you can set multiple instance families. Valid values of N: 1 to 10.	ecs.g6
MinimumCpuCoreCount	integer	No	The minimum number of vCPUs of the instance type.	2
MaximumCpuCoreCount	integer	No	The maximum number of vCPUs of the instance type.	4
GpuSpecs	array	No	The GPU type.
	string	No	The GPU type.	NVIDIA V100
InstanceCategories	array	No	The instance type categorization. Valid values: General-purpose: general-purpose. Compute-optimized: compute-optimized. Memory-optimized: memory-optimized. Big data: big data. Local SSDs: local SSD. High Clock Speed: high frequency. Enhanced: enhanced. Shared: shared. Compute-optimized with GPU: GPU-accelerated compute-optimized. Visual Compute-optimized: visual compute-optimized. Heterogeneous Service: heterogeneous service. Compute-optimized with FPGA: FPGA-accelerated compute-optimized. Compute-optimized with NPU: NPU-accelerated compute-optimized. ECS Bare Metal: Elastic Compute Service Bare Metal Instance server. High Performance Compute: high-performance computing (HPC).
	string	No	The instance type categorization. Valid values: General-purpose: general-purpose. Compute-optimized: compute-optimized. Memory-optimized: memory-optimized. Big data: big data. Local SSDs: local SSD. High Clock Speed: high frequency. Enhanced: enhanced. Shared: shared. Compute-optimized with GPU: GPU-accelerated compute-optimized. Visual Compute-optimized: visual compute-optimized. Heterogeneous Service: heterogeneous service. Compute-optimized with FPGA: FPGA-accelerated compute-optimized. Compute-optimized with NPU: NPU-accelerated compute-optimized. ECS Bare Metal: Elastic Compute Service Bare Metal Instance server. High Performance Compute: high-performance computing (HPC).	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 specifies that you can set multiple CPU architectures. Valid values of N: 1 to 2. X86. ARM.	X86
PhysicalProcessorModels	array	No	The processor models of the instance. N specifies that you can set multiple processor models. Valid values of N: 1 to 10.
	string	No	The processor models of the instance. N specifies that you can set 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) that can be attached to the instance.	2
MinimumEniPrivateIpAddressQuantity	integer	No	The minimum number of IPv4 addresses per elastic network interfaces (ENIs) on the instance.	2
MinimumEniIpv6AddressQuantity	integer	No	The minimum number of IPv6 addresses per elastic network interfaces (ENIs) on the instance.	1
MinimumInitialCredit	integer	No	The minimum initial vCPU credits for burstable instances (t5 and t6).	12
MinimumBaselineCredit	integer	No	The minimum baseline vCPU computing performance (sum of all vCPUs) for burstable 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 on the instance. Valid values: positive integers.	2
MaximumGpuAmount	integer	No	The maximum number of GPUs on 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 instance types that match the specified conditions.
	object	The instance types that match the specified conditions.
InstanceType	string	The name of the instance type.	ecs.c7.xlarge
InstanceFamilyLevel	string	The instance family level. Valid values: EntryLevel: entry level, which refers to shared instance types. These instance types are more cost-effective but do not guarantee stable computing performance. They are suitable for scenarios in which CPU utilization is low. For more information, see Shared instance types. EnterpriseLevel: enterprise level. These instance types provide stable performance and dedicated resources. They are suitable for scenarios that require high stability. For more information, see Instance families. CreditEntryLevel: credit-based entry level, which refers to burstable instances. These instance types use CPU credits to ensure computing performance. They are suitable for scenarios in which CPU utilization is typically low with occasional bursts. For more information, see Burstable instances.	EnterpriseLevel
InstanceTypeFamily	string	The instance family.	ecs.c7
Cores	integer	The number of vCPUs 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.