Creates an auto provisioning group.

Description

  • Auto Provisioning is a service that allows quick deployment of an instance cluster that consists of preemptible and pay-as-you-go instances. Auto Provisioning supports one-click deployment of instance clusters that are of specific billing methods and instance families across different zones. For more information, see Use auto provisioning group-related API operations to create multiple ECS instances at the same time.
  • Auto Provisioning uses auto provisioning groups to schedule and maintain computing resources. You can use auto provisioning groups to provide stable computing resources. This alleviates the instability caused by the reclaiming of preemptible instances.
  • Auto provisioning is free to use. However, you are charged for instance resources that are created in auto provisioning groups. For more information on billing, see Preemptible instance and Pay-as-you-go.
  • When you specify both the LaunchTemplateId and LaunchConfiguration.* parameters, the LaunchTemplateId parameter takes precedence.

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 CreateAutoProvisioningGroup

The operation that you want to perform. Set the value to CreateAutoProvisioningGroup.

RegionId String Yes cn-hangzhou

The region ID of the auto provisioning group. You can call the DescribeRegions operation to query the most recent region list.

TotalTargetCapacity String Yes 60

The total target capacity of the auto provisioning group. The value must be a positive integer.

The total target capacity of the auto provisioning group must be at least the sum of the target capacity of pay-as-you-go instances specified by the PayAsYouGoTargetCapacity parameter and the target capacity of preemptible instances specified by the SpotTargetCapacity parameter.

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which to add the auto provisioning group.

AutoProvisioningGroupName String No apg-test

The name of the auto provisioning group. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

AutoProvisioningGroupType String No maintain

The delivery type of the auto provisioning group. Valid values:

  • request: one-time asynchronous delivery. When the auto provisioning group is started, it attempts to asynchronously deliver an instance cluster that meets the target capacity only once. The group does not retry the operation regardless of whether all the instances are delivered.
  • instant: one-time synchronous delivery. When the auto provisioning group is started, it attempts to synchronously deliver an instance cluster that meets the target capacity only once. The list of delivered instances and the causes of delivery failures are returned in the response.
  • maintain: continuous delivery. When the auto provisioning group is started, it attempts to deliver an instance cluster that meets the target capacity, and monitors the real-time capacity. If the target capacity of the auto provisioning group is not reached, the auto provisioning group continues to create instances until the target capacity is reached.

Default value: maintain.

SpotAllocationStrategy String No diversified

The policy for creating preemptible instances. Valid values:

  • lowest-price: cost optimization policy. The auto provisioning group attempts to create instances of the lowest-priced instance type.
  • diversified: balanced distribution policy. The auto provisioning group attempts to create instances in zones that are specified in extended configurations and then evenly distributes the instances across the zones.
  • capacity-optimized: capacity-optimized distribution policy. The auto provisioning group attempts to create instances that are of the optimal instance types across the optimal zones based on the resource availability.

Default value: lowest-price.

SpotInstancePoolsToUseCount Integer No 2

The number of preemptible instances of the lowest-priced instance type to be created by the auto provisioning group. This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price.

The parameter value must be smaller than N specified in the LaunchTemplateConfig.N parameter.

PayAsYouGoAllocationStrategy String No prioritized

The policy for creating pay-as-you-go instances. Valid values:

  • lowest-price: cost optimization policy. The auto provisioning group attempts to create instances of the lowest-priced instance type.
  • prioritized: the priority-based policy. The auto provisioning group attempts to create instances based on the priority specified by the LaunchTemplateConfig.N.Priority parameter.

Default value: lowest-price.

ExcessCapacityTerminationPolicy String No termination

Specifies whether to release the removed instances after the real-time capacity of the auto provisioning group exceeds the target capacity and a scale-in event is triggered. Valid values:

  • termination: releases the removed instances.
  • no-termination: only removes the instances from the auto provisioning group but does not release them.

Default value: no-termination.

ValidFrom String No 2019-04-01T15:10:20Z

The time at which the auto provisioning group starts. The period of time between this point in time and the point in time specified by the ValidUntil parameter is the effective time period of the auto provisioning group.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

By default, an auto provisioning group is immediately started after it is created.

ValidUntil String No 2019-06-01T15:10:20Z

The time at which the auto provisioning group expires. The period of time between this point in time and the point in time specified by the ValidFrom parameter is the effective time period of the auto provisioning group.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Default value: 2099-12-31T23:59:59Z.

TerminateInstancesWithExpiration Boolean No true

Specifies whether to release instances in the auto provisioning group when the auto provisioning group expires. Valid values:

  • true: releases instances in the auto provisioning group.
  • false: only removes instances from the auto provisioning group but does not release them.

Default value: false.

TerminateInstances Boolean No true

Specifies whether to release instances in the auto provisioning group when the auto provisioning group is deleted. Valid values:

  • true: releases instances in the auto provisioning group.
  • false: retains instances in the auto provisioning group.

Default value: false.

MaxSpotPrice Float No 2

The maximum price of preemptible instances in the auto provisioning group.

Note When both the MaxSpotPrice and LaunchTemplateConfig.N.MaxPrice parameters are specified, the smaller one of the two parameter values is used.
PayAsYouGoTargetCapacity String No 30

The target capacity of pay-as-you-go instances in the auto provisioning group. Valid values: smaller than the value of the TotalTargetCapacity parameter.

SpotTargetCapacity String No 20

The target capacity of preemptible instances in the auto provisioning group. Valid values: smaller than the value of the TotalTargetCapacity parameter.

DefaultTargetCapacityType String No Spot

The type of supplemental instances. When the total value of PayAsYouGoTargetCapacity and SpotTargetCapacity is smaller than the value of TotalTargetCapacity, the auto provisioning group creates instances of the specified type to meet the target capacity. Valid values:

  • PayAsYouGo: pay-as-you-go instances
  • Spot: preemptible instances

Default value: Spot.

LaunchTemplateId String No lt-bp1fgzds4bdogu03****

The ID of the launch template associated with the auto provisioning group. You can call the DescribeLaunchTemplates operation to query available launch templates. When you specify both this parameter and the LaunchConfiguration.* parameter, this parameter takes precedence.

LaunchTemplateVersion String No 1

The version of the launch template associated with the auto provisioning group. You can call the DescribeLaunchTemplateVersions operation to query the versions of available launch templates.

Default value: the default version of the launch template.

Description String No testDescription

The description of the auto provisioning group.

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe637760

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Make sure that the token is unique among different requests. ClientToken contains only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence.

LaunchConfiguration.ImageId String No m-bp1g7004ksh0oeuc****

The ID of the image used to create instances. You can call the DescribeImages operation to query available image resources. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SecurityGroupId String No sg-bp15ed6xe1yxeycg****

The ID of the security group to which to assign the instance. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.IoOptimized String No optimized

Specifies whether the instance is I/O optimized. Valid values:

  • none: The instance is not I/O optimized.
  • optimized: The instance is I/O optimized.

For instances of retired instance types, the default value is none. For instances of other instance types, the default value is optimized.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.InternetChargeType String No PayByTraffic

The billing method for network usage. Valid values:

  • PayByBandwidth: pay-by-bandwidth
  • PayByTraffic: pay-by-traffic
Note When the pay-by-traffic billing method is used, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. When resources are insufficient, these maximum bandwidths cannot be guaranteed. If you want guaranteed bandwidth for your instance, use the pay-by-bandwidth billing method.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.InternetMaxBandwidthIn Integer No 10

The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:

  • If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, valid values of this parameter are 1 to 10, and the default value of this parameter is 10.
  • If the purchased outbound public bandwidth is greater than 10 Mbit/s, valid values of this parameter are 1 to the value of LaunchConfiguration.InternetMaxBandwidthOut, and the default value is the value of LaunchConfiguration.InternetMaxBandwidthOut.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.InternetMaxBandwidthOut Integer No 10

The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.

Default value: 0

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.InstanceName String No k8s-node-[1,4]-alibabacloud

The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The default value of this parameter is the InstanceId value.

When you create multiple instances at a time, you can batch specify sequential names for the instances. For more information, see Batch configure sequential names or hostnames for multiple instances.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.HostName String No k8s-node-[1,4]-ecshost

The hostname of the instance. The following limits apply:

  • The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).
  • For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
  • You cannot specify both the LaunchConfiguration.HostName and LaunchConfiguration.HostNames.N parameters. Otherwise, an error message appears.
  • When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.
LaunchConfiguration.InstanceDescription String No Instance_Description

The description of the instance. The description must be 2 to 256 characters in length and cannot start with http:// or https://. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.KeyPairName String No KeyPair_Name

The name of the key pair to be bound to the instance.

  • For Windows instances, this parameter is ignored. This parameter is left empty by default.
  • For Linux instances, the username and password authentication method is disabled by default.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.RamRoleName String No RAM_Name

The name of the instance RAM role. You can call the ListRoles operation provided by Resource Access Management (RAM) to query the instance RAM roles that you created. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SecurityEnhancementStrategy String No Active

Specifies whether to enable security hardening. Valid values:

  • Active: Security hardening is enabled. This value is applicable only to public images.
  • Deactive: Security hardening is disabled. This value is applicable to all image types.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.UserData String No ZWNobyBoZWxsbyBlY3Mh

The user data of the instance. User data must be encoded in Base64. The maximum size of raw data is 16 KB. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SystemDiskCategory String No cloud_ssd

The category of the system disk. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: enhanced ESSD (ESSD)
  • cloud: basic disk

For non-I/O optimized instances of retired instance types, the default value is cloud. For other instances, the default value is cloud_efficiency.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SystemDiskSize Integer No 40

The size of the system disk. Valid values: 20 to 500. Unit: GiB. This parameter value must be at least 20 and greater than or equal to the size of the image specified by the LaunchConfiguration.ImageId parameter.

Default value: 40 or the size of the image specified by the LaunchConfiguration.ImageId parameter, whichever is greater.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SystemDiskName String No cloud_ssdSystem

The name of the system disk. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-).

This parameter is empty by default.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SystemDiskDescription String No SystemDisk_Description

The description of the system disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.SystemDiskPerformanceLevel String No PL0

The performance level of the ESSD used as the system disk. Default value: PL0. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSD.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.PasswordInherit Boolean No true

Specifies whether to use the password that is preset in the image. Valid values:

  • true: The preset password is used.
  • false: The preset password is not used.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which to assign the instance. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.CreditSpecification String No Standard

The performance mode of the burstable instance. Valid values:

  • Standard: the standard mode. For more information, see the "Standard mode" section in Burstable instances.
  • Unlimited: the unlimited mode. For more information, see the "Unlimited mode" section in Burstable instances.

This parameter is empty by default.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DeploymentSetId String No ds-bp1frxuzdg87zh4p****

The ID of the deployment set to which to deploy the instance.

MinTargetCapacity String No 20

The minimum target capacity of the auto provisioning group. The value must be a positive integer.

When you specify this parameter, take note of the following items:

  • This parameter takes effect only when AutoProvisioningGroupType is set to instance.
  • If the number of instances that can be created in the current region is smaller than the value of this parameter, the operation cannot be called, and no instances are created.
  • If the number of instances that can be created in the current region is greater than the value of this parameter, instances can be created based on specified parameters.
LaunchTemplateConfig.N.VSwitchId String No vsw-sn5bsitu4lfzgc5o7****

The ID of the vSwitch in extended configuration N. The zone of the ECS instances created from the extended configurations is determined by the vSwitch.

Note If you set the LaunchTemplateConfig parameter, you must also set the LaunchTemplateConfig.N.VSwitchId parameter.
LaunchTemplateConfig.N.MaxPrice Double No 3

The maximum price of preemptible instances in extended configuration N.

Note If you set the LaunchTemplateConfig parameter, you must also set the LaunchTemplateConfig.N.MaxPrice parameter.
LaunchTemplateConfig.N.Priority Integer No 1

The priority of extended configuration N. A value of 0 indicates the highest priority. Valid values: 0 to ∞.

LaunchTemplateConfig.N.InstanceType String No ecs.g5.large

The instance type in extended configuration N. Valid values of N: 1 to 20. For more information about the valid values of this parameter, see Instance families.

LaunchTemplateConfig.N.WeightedCapacity Double No 2

The weight of the instance type specified in extended configuration N. A greater weight indicates that a single instance has more computing power and that fewer instances are required. The value must be greater than 0.

The weight is calculated based on the computing power of the specified instance type and the minimum computing power of a single instance in the cluster to be created by the auto provisioning group. For example, if the minimum computing power of a single instance is 8 vCPUs and 60 GiB:

  • The weight of the instance type that has 8 vCPUs and 60 GiB can be set to 1.
  • The weight of the instance type that has 16 vCPUs and 120 GiB can be set to 2.
LaunchConfiguration.DataDisk.N.PerformanceLevel String No PL1

The performance level of the ESSD used as data disk N. The value of N must be the same as that of N in the LaunchConfiguration.DataDisk.N.Category parameter. Default value: PL1. Valid values:

  • PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.
  • PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.
  • PL2: A single ESSD delivers up to 100,000 random read/write IOPS.
  • PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.

For more information about ESSD performance levels, see ESSDs.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.KmsKeyId String No 0e478b7a-4262-4802-b8cb-00d3fb40****

The ID of the KMS key used by data disk N. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.Description String No DataDisk_Description

The description of data disk N. The description must be 2 to 256 characters in length and cannot start with http:// or https://. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.SnapshotId String No s-bp17441ohwka0yuh****

The ID of the snapshot used to create data disk N. Valid values of N: 1 to 16.

After this parameter is specified, the LaunchConfiguration.DataDisk.N.Size parameter is ignored. The size of data disk N is the same as that of the snapshot specified by this parameter. You must use snapshots created after July 15, 2013. Otherwise, an error message appears and your request is rejected.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.Size Integer No 20

The size of data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:

  • Valid values when LaunchConfiguration.DataDisk.N.Category is set to cloud_efficiency: 20 to 32768
  • Valid values when LaunchConfiguration.DataDisk.N.Category is set to cloud_ssd: 20 to 32768
  • Valid values when LaunchConfiguration.DataDisk.N.Category is set to cloud_essd: 20 to 32768
  • Valid values when LaunchConfiguration.DataDisk.N.Category is set to cloud: 5 to 2000
Note The parameter value must be greater than or equal to the size of the snapshot specified by the LaunchConfiguration.DataDisk.N.SnapshotId parameter.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.Device String No /dev/vd1

The mount point of data disk N. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.DiskName String No cloud_ssdData

The name of data disk N. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, periods (.), colons (:), underscores (_), and hyphens (-).

This parameter is empty by default.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.Category String No cloud_ssd

The category of data disk N. Valid values of N: 1 to 16. Valid values:

  • cloud_efficiency: ultra disk.
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • cloud: basic disk.

For I/O optimized instances, the default value is cloud_efficiency. For non-I/O optimized instances, the default value is cloud.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.DeleteWithInstance Boolean No true

Specifies whether to release data disk N when its attached instance is released. Valid values:

  • true: Data disk N is released together with the instance.
  • false: Data disk N is not released together with the instance.

Default value: true.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.DataDisk.N.Encrypted Boolean No false

Specifies whether to encrypt data disk N. Valid values:

  • true: Data disk N is encrypted.
  • false: Data disk N is not encrypted.

Default value: false.

When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter is preferentially used.

LaunchConfiguration.Tag.N.Key String No TestKey

The tag key of the instance. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be up to 128 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

LaunchConfiguration.Tag.N.Value String No TestValue

The tag value of the instance. Valid values of N: 1 to 20. The tag value can be an empty string. It can be up to 128 characters in length. It cannot start with acs: or contain http:// or https://. When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

SystemDiskConfig.N.DiskCategory String No cloud_ssd

The category of system disk N. You can use this parameter to specify multiple disk categories and specify the priority for each disk category. If a disk category is unavailable, the system uses the next disk category. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • cloud: basic disk
DataDiskConfig.N.DiskCategory String No cloud_efficiency

The category of data disk N. You can use this parameter to specify multiple disk categories and specify the priority for each disk category. If a disk category is unavailable, the system uses the next disk category. Valid values:

  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • cloud: basic disk
LaunchConfiguration.HostNames.N RepeatList No ecs-host-01

The hostnames specified for one or more instances. The following limits apply:

  • This parameter takes effect only when AutoProvisioningGroupType is set to instance.
  • The value of N indicates the number of the instances. Valid values: 1 to 1000. The value of N is the same as that of the TotalTargetCapacity parameter.
  • The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).
  • For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).
  • You cannot specify both the LaunchConfiguration.HostName and LaunchConfiguration.HostNames.N parameters. Otherwise, an error message appears.
  • When both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.

Response parameters

Parameter Type Example Description
AutoProvisioningGroupId String apg-sn54avj8htgvtyh8****

The ID of the auto provisioning group.

LaunchResults Array of LaunchResult

Details about the instances created by the auto provisioning group. The value of this parameter is returned only when AutoProvisioningGroupType is set to instant.

LaunchResult
ErrorCode String InvalidParameter

The error code returned when the instance cannot be created.

ErrorMsg String Specific parameter is not valid.

The error message returned when the instance cannot be created.

InstanceIds List ["i-bp67acfmxazb4p****"]

The IDs of instances created.

InstanceType String ecs.g5.large

The instance type of the instance.

SpotStrategy String NoSpot

The preemption policy for the pay-as-you-go instance. Possible values:

  • NoSpot: The instance is created as a regular pay-as-you-go instance.
  • SpotWithPriceLimit: The instance is created as a preemptible instance that has a user-defined maximum hourly price.
  • SpotAsPriceGo: The instance is created as a preemptible instance whose price is based on the market price at the time of purchase.
ZoneId String cn-hangzhou-g

The zone ID of the instance.

RequestId String 745CEC9F-0DD7-4451-9FE7-8B752F39****

The request ID.

Samples

Sample requests

https://ecs.aliyuncs.com/?Action=CreateAutoProvisioningGroup
&LaunchTemplateId=lt-bp1fgzds4bdogu03****
&RegionId=cn-hangzhou
&TotalTargetCapacity=60
&SpotInstancePoolsToUseCount=2
&ExcessCapacityTerminationPolicy=termination
&TerminateInstancesWithExpiration=true
&TerminateInstances=false
&PayAsYouGoTargetCapacity=30
&SpotTargetCapacity=20
&DefaultTargetCapacityType=Spot
&LaunchTemplateConfig.1.InstanceType=ecs.g5.large
&LaunchTemplateConfig.1.MaxPrice=3
&LaunchTemplateConfig.1.VSwitchId=vsw-sn5bsitu4lfzgc5o7****
&LaunchTemplateConfig.1.WeightedCapacity=2
&LaunchTemplateConfig.1.Priority=1
&<Common request parameters>

Sample success responses

XML format

<CreateAutoProvisioningGroupResponse>
    <AutoProvisioningGroupId>apg-sn54avj8htgvtyh8****</AutoProvisioningGroupId>
    <RequestId>745CEC9F-0DD7-4451-9FE7-8B752F39****</RequestId>
</CreateAutoProvisioningGroupResponse>

JSON format

{
    "AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
    "RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****"
}

Error codes

HTTP status code Error code Error message Description
400 InvalidParameter %s The error message returned because a specified parameter is invalid.
400 InvalidFleetExcessCapacityTerminationPolicy.ValueNotSupported The specified parameter "ExcessCapacityTerminationPolicy" is not supported. The error message returned because the specified ExcessCapacityTerminationPolicy parameter is invalid.
400 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred. Try later. If the error persists, submit a ticket.
400 MissingParameter %s The error message returned because a required parameter is not specified.

For a list of error codes, visit the API Error Center.