Auto Scaling
Auto Scaling
Document
- Documentation
Auto ScalingAPI ReferenceScalingConfigurationCreateScalingConfiguration - Creates a scaling configuration
Copy page
Download PDFScalingConfiguration
CreateScalingConfiguration - Creates a scaling configuration
Copy pageDownload PDFCreateScalingConfiguration - Creates a scaling configuration
Create a scaling configuration. For operation instructions and precautions, see Managing scaling configurations.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.
Action string required Sample value: CreateScalingConfiguration
The operation that you want to perform. Valid value: CreateScalingConfiguration.
Version string required Sample value: 2020-01-01
The version of the API. Value: 2020-01-01.
Eip.SecurityProtectionTypes.N string[] Optional Sample value: AntiDDoS_Enhanced
The security protection type of EIP.
- N specifies the serial number of the protection type. Currently, only 1 is supported.
- Valid values:
- AntiDDoS_Enhanced: EIP of the Security Enhanced type, which can be added to an Anti-DDoS Origin instance.
- If no argument is passed in, this indicates applying for an EIP of the basic protection type.
ProjectName string Optional Sample value: default
The project to which the instance created based on the scaling configuration belongs. By default, this parameter is empty. A resource can belong to only one project.
- Only letters, digits, underscores (_), hyphens (-), and dots (.) are allowed.
- The length is limited to 64 characters.
SecurityGroupIds.N string[] required Sample value: sg-3ti78x9h8t4bw****
The ID of the security group associated with the instance's primary network interface. You can call DescribeSecurityGroups to query the security group ID. Value:
- Parameter - N: The serial number of the security group associated with the primary network interface. Up to 5 security groups can be associated. Valid values: 1 - 5.
- Parameter - SecurityGroupId: The ID of the Nth security group associated with the primary network interface.
- Separate multiple security group IDs with ampersands (&).
Tags string Optional Sample value: "k1":"v1"
The tags for instances created based on the scaling configuration. Tags are passed in as key-value pairs. You can pass in up to 20 key-value pairs. Key naming rules are as follows:
- Key naming rules:
- It cannot start with volc: or sys: in any case form.
tip
Tags with keys prefixed with volc: or sys: are reserved for system use. You cannot create tags that use these prefixes.
- It can contain only language characters, digits, spaces, and English symbols of " _", ".", ":", "/", "=", "+", "-", and "@".
- It must be 1 to 128 characters in length.
Duplicate tag keys are not allowed within the same scaling configuration.
- Value naming rules:
- Only language characters, digits, spaces, and English symbols of " _", ".", ":", "/", "=", "+", "-", and "@" are allowed.
- It can be empty. Length limit: 0-256 characters.
ClientToken string Optional Sample value: 333456899ff****
The ClientToken is used to ensure the request idempotency. You can use the client to automatically generate a token, but you must make sure that the token is unique among different requests. This prevents repeated actions due to multiple client retries when the call of the API operation times out or an internal server error occurs. Values:
- Not more than 64 ASCII characters.
HpcClusterId string Optional Sample value: hpcCluster-ycdj7d9ios38dfny****
The ID of the HPC cluster to which the instance belongs.
This parameter is valid only when InstanceTypes.N is set to HPC-optimized instance type.
Eip.SecurityProtectionInstanceId integer Optional Sample value: 193
The security package ID.
tip
This parameter is required when Eip.SecurityProtectionTypes.N is not empty.
ScalingGroupId string required Sample value: scg-ybmssdnnhn5pkgyd****
The ID of the scaling group to which the scaling configuration belongs. You can call DescribeScalingGroups to query the scaling group ID.
Ipv6AddressCount integer Optional Sample value: 0
Whether to assign IPv6 addresses to the instance's network interfaces. Value:
- 0: Do not assign IPv6 addresses.
- 1: Assign IPv6 addresses. The system automatically allocates an IPv6 CIDR block.
SpotStrategy string Optional Sample value: NoSpot
The spot policy of the instances. Value:
- NoSpot (default): Creates regular Pay-as-you-go instances.
- SpotAsPriceGo: Creates spot instances with auto-bidding that follows the current market price.
- SpotWithPriceLimit: Creates spot instances with a user-defined maximum bid price.
Eip.BandwidthPackageId string Optional Sample value: bwp-2zeo05qre24nhrqpy****
ID of the shared bandwidth package. This means you add the EIP to the specified shared bandwidth package. You can call the DescribeBandwidthPackages operation to query IDs of shared bandwidth packages. To associate an EIP with a shared bandwidth package, the following conditions are required:
- The EIP and bandwidth package must be of the same security mode.
- The EIP and shared bandwidth package must be of the same ISP type.
- Shared bandwidth package is of the IPv4 type.
ImageId string required Sample value: image-ybmhzqo8u4l8j1ii****
The ID of the image. This parameter specifies the image resource used by the scaling group to create instances automatically. You can call DescribeImages to query image IDs.
Volumes.N.ExtraPerformanceThroughputMB integer[] Optional Sample value: 40
The capacity of additional throughput performance (unit: MB/s) for the volume. Only ESSD FlexPL data volumes support additional throughput performance. When ExtraPerformanceTypeId is Throughput, configure this parameter. Value range: 1–650.
tip
- Argument - N: indicates the serial number of the volume. Valid range: 1–16. N = 1 indicates the system volume. When N is passed in as 1, this parameter is ignored. N ≥ 2 indicates the data volume, and this parameter can be normally passed in.
- Separate multiple volumes with ampersands (&).
Volumes.N.ExtraPerformanceIOPS integer[] Optional Sample value: 40
The capacity of additional IOPS performance (unit:ops/sec, operations per second) for the volume. Only ESSD FlexPL data volumes support additional IOPS performance. When ExtraPerformanceTypeId is set to Balance or IOPS, configure this parameter. The value ranges for each type of extra performance are as follows:
- IOPS: 1–50000
- Balance: 1–50000
tip
- Parameter - N: This specifies the number of the volume. Valid value: 1–16. N = 1 indicates the system volume. When N is passed in as 1, this parameter is ignored. N ≥ 2 indicates the data volume, and this parameter can be normally passed in.
- Separate multiple volumes with ampersands (&).
Eip.ReleaseWithInstance boolean Optional Sample value: false
Whether the EIP is deleted along with the instance.
This parameter takes effect only when an instance with a Pay-as-you-go EIP is deleted in the ECS console. For the retention rules of EIPs when instances are removed from the scaling group, see the detailed description in Instance management. Value:
- true: The EIP is deleted along with the instance.
- false (default): The EIP is not deleted when the instance is deleted.
InstanceTypeOverrides.N.InstanceType string[] Optional Sample value: ecs.g2i.large
The type of spot instances.
- Parameter - N: Specifies the serial number of the instance type. Valid value: 1–10.
- Parameter - InstanceType: The type of spot instances.
- Use & to separate multiple types.
tip
This parameter is valid only when SpotStrategy is set to SpotWithPriceLimit.
InstanceTypeOverrides.N.PriceLimit float[] Optional Sample value: 0.01
The maximum hourly price for the spot instance type.
- Parameter - N: Specifies the serial number of the instance type. Valid value: 1–10.
- Value - PriceLimit: The maximum hourly price for the spot instance type. Value: greater than 0, with a maximum of 3 decimal places.
- Separate multiple prices with &.
tip
This parameter is valid only when SpotStrategy is set to SpotWithPriceLimit.
Volumes.N.ExtraPerformanceTypeId string[] Optional Sample value: IOPS
The type of additional performance for the volume. This feature is only supported by ESSD FlexPL data volumes. For more information about additional performance, please refer to Volume additional performance.
Valid range:
- Balance: balanced additional performance.
- IOPS: IOPS additional performance.
- Throughput: throughput additional performance.
tip
- Argument - N: indicates the serial number of the volume. Valid range: 1–16. N = 1 indicates the system volume. When N is passed in as 1, this parameter is ignored. N ≥ 2 indicates the data volume, and this parameter can be normally passed in.
- Separate multiple volumes with ampersands (&).
Eip.Bandwidth integer Optional Sample value: 1
The peak bandwidth of the EIP. Default value: 1. Unit: Mbps. Value:
- When Eip.BillingType is set to PostPaidByBandwidth, the value ranges from 1 to 500.
- When Eip.BillingType is set to PostPaidByTraffic, the value ranges from 1 to 200.
tip
To enable automatic allocation of an EIP when an instance joins the scaling group, you must configure at least one of Eip.Bandwidth, Eip.ISP, or Eip.BillingType. If none are configured, no EIP will be allocated.
Eip.BillingType string Optional Sample value: PostPaidByBandwidth
The billing method of the EIP. Valid values:
- PostPaidByBandwidth (default): Pay-as-you-go-Pay-by-bandwidth.
- PostPaidByTraffic: Pay-as-you-go-Pay-by-data-transfer.
tip
To enable automatic allocation of an EIP when an instance joins the scaling group, you must configure at least one of Eip.Bandwidth, Eip.ISP, or Eip.BillingType. If none are configured, no EIP will be allocated.
Eip.ISP string Optional Sample value: BGP
The ISP type. Valid values:
- BGP (default): BGP line.
- If your account has applied for static single-line access, the ISP parameter can also be set to ChinaMobile (China Mobile), ChinaTelecom (China Telecom), or ChinaUnicom (China Unicom).
tip
To enable automatic allocation of an EIP when an instance joins the scaling group, you must configure at least one of Eip.Bandwidth, Eip.ISP, or Eip.BillingType. If none are configured, no EIP will be allocated.
HostName string Optional Sample value: instance-host-name
Instance hostname Value:
- Linux instance
- Periods can be used to separate the hostname into multiple segments. Each segment can contain letters, digits, or hyphens "-".
- The hostname cannot start or end with a period "." or hyphen "-", and periods "." or hyphens "-" cannot be used consecutively.
- The length of the hostname for Linux systems is limited to 2 to 63 characters.
- Windows instances
- Letters, numbers, or hyphens "-" are allowed. The name can not be comprised of numbers only.
- The hostname cannot start or end with a hyphen "-", and hyphens "-" cannot be used consecutively.
- The length of the hostname for Windows systems is limited to 2 to 15 characters.
If no argument is filled in, the hostname is automatically generated based on the following rules:
- Format: iv- + initial hostname. For example, iv-3tigy72q3u3vj0******.
- The hostname generation logic for existing instances remains unchanged and does not change upon instance restart.
- Generation logic of the initial hostname:
- Linux instances: Extract all characters after instance ID i-.
- Windows instances: Extract the last 12 characters after instance ID i-.
tip
You can configure sequential and unique instance names or hostnames for instances created during scale-out. For configuration rules, see Configuring sequential and unique instance names or hostnames.
InstanceDescription string Optional Sample value: ECS instance
The description of the instance. Valid range:
- Cannot start with a number or a hyphen (-).
- Only Chinese, letters, numbers, underscores and hyphens are allowed.
- The length is limited to 0 ~ 255 characters.
- If left blank, the parameter defaults to an empty string.
InstanceName string required Sample value: instance-test
The instance name. Valid range:
- Start with a letter or Chinese.
- Only Chinese characters, letters, digits, underscores (_), hyphens (-), and dots (.) are allowed.
- It must be 1 to 128 characters in length.
tip
You can configure sequential and unique instance names or hostnames for instances created during scale-out. For configuration rules, see Configuring sequential and unique instance names or hostnames.
InstanceTypes.N string[] Optional Sample value: ecs.g2a.large
The list of instance types. You can call DescribeAvailableResource to query the stock information of instance types.
KeyPairName string Optional Sample value: kp-test-123
When you use "SSH Key" to log in to the instance, enter the name of the key pair.
If the KeyPairName and Password parameters are specified at the same time, only the KeyPairName parameter takes effect.
Password string Optional Sample value: password@123
The password required for logging in to the instance as the root user.
- The length is limited to 8 ～ 30 characters
- A password can only consist of uppercase letters, lowercase letters, numbers, and special characters, and must include at least three of these elements
- Special characters allowed: `~!@#$%^&*()_-+= |
- A password can not start with "/" or "$6$"
ScalingConfigurationName string required Sample value: scaling-config-test
The name of the scaling configuration. Within the same region and scaling group, the scaling configuration name must be unique. Valid value:
- It must start with a letter or Chinese character.
- Only Chinese, letters, numbers, underscores and hyphens are allowed.
- The name must be 1 to 128 characters in length.
- Special characters are currently not supported.
SecurityEnhancementStrategy string Optional Sample value: Active
Whether to enable security enhancement. Value:
- Active: Enables security enhancement. This feature is effective for public images only.
- InActive: Disables security enhancement. This feature is effective for all images.
UserData string Optional Sample value: ZWNobyBoZWxsbyBlY3Mh
Instance custom data. The custom data for an instance must be encoded in Base64 format, and the data can not exceed 16 KB before Base64 encoding.
If left blank, the parameter defaults to an empty value.
Volumes.N.DeleteWithInstance boolean[] Optional Sample value: true
Whether the volume is released with the instance:
- Parameter - N: Specifies the serial number of the volume. No. 1 represents the system volume. No. 2 or greater represents a data volume. Valid value: 1 - 15.
- Parameter - DeleteWithInstance: Whether the volume is released along with the instance.
- true (default): The volume is released with the instance.
- false: The volume is not released with the instance.
- When "false" is passed in, this configuration is invalid on the system volume. By default, the system volume is released with the instance and can not be retained.
Volumes.N.Size integer[] required Sample value: 100
The volume capacity. Unit: GiB.
- Parameter - N: Specifies the serial number of the volume. No. 1 represents the system volume. No. 2 or greater represents a data volume. Valid value: 1-15.
- Value - Size: The capacity of the Nth volume. Unit: GiB.
- Valid value for the system volume: 10 - 500.
- Valid value for data volumes: 10 - 8192.
- Separate multiple volumes with ampersands (&).
Volumes.N.VolumeType string[] required Sample value: ESSD_PL0
The volume type:
- Parameter - N: Specifies the serial number of the volume. No. 1 represents the system volume. No. 2 or greater represents a data volume. Valid value: 1-15.
- Parameter - VolumeType: The type of the Nth volume. Valid value:
- ESSD_FlexPL: ESSD FlexPL
- ESSD_PL0: ESSD PL0.
- Separate multiple volumes with ampersands (&).
ZoneId string Optional Sample value: cn-beijing-a
The availability zone ID of the scaling configuration.
Response parameters
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.
ScalingConfigurationId string Sample value: scc-ybmt16auaugh9zfy****
The scaling configuration ID.
Sample request
Sample response
Error codes
The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.
Last updated: 2026.06.24 17:08:53
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
