云服务器 ECS：CreateAutoProvisioningGroup - 创建弹性供应组

弹性供应组所在地域的 ID，您可以调用 DescribeRegions 查看最新的阿里云地域列表。

弹性供应组所在的企业资源组 ID。

弹性供应组的名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以http://和https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。

弹性供应组的交付类型。取值范围：

• request：一次性异步交付。供应组仅在启动时异步交付实例集群，调度失败后不再重试。

• instant：一次性同步交付。供应组仅在启动时同步创建实例，并在请求响应中返回创建成功的实例列表和创建失败的原因。

• maintain：持续供应。供应组在启动时尝试交付实例集群，并监控实时容量，未达到目标容量则尝试继续创建 ECS 实例。

默认值：maintain。

创建抢占式实例的策略。取值范围：

• lowest-price：成本优化策略。选择价格最低的实例规格。

• diversified：均衡可用区分布策略。在扩展启动模板指定的可用区内创建实例，均匀分布到各可用区。

• capacity-optimized：容量优化分布策略。根据库存情况，选择最优的实例规格和可用区进行创建。

默认值：lowest-price。

竞价实例中断时的行为。取值范围：

• stop：停止实例。

• terminate：释放实例。

默认值：terminate。

在SpotAllocationStrategy为lowest-price时生效，表示弹性供应组选择价格最低的实例规格创建实例的数量。

取值范围：低于LaunchTemplateConfig.N中 N 的取值。

创建按量付费实例的策略。取值范围：

• lowest-price：成本优化策略。选择价格最低的实例规格。

• prioritized：优先级策略。按照LaunchTemplateConfig.N.Priority设定的优先级创建实例。

默认值：lowest-price。

弹性供应组实时容量超过目标容量并触发缩容时，是否释放缩容的实例。取值范围：

• termination：释放缩容的实例。
• no-termination：只将缩容的实例移出弹性供应组。

默认值：no-termination。

弹性供应组的启动时间，和ValidUntil共同确定有效时段。

按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

默认值：该接口立即生效的时间戳。

弹性供应组的到期时间，和ValidFrom共同确定有效时段。

按照ISO 8601标准表示，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

默认值：2099-12-31T23:59:59Z。

弹性供应组到期时，是否释放组内实例。取值范围：

• true：释放组内实例。
• false：只将组内实例移出弹性供应组。

默认值：false。

删除弹性供应组时，是否释放组内实例。取值范围：

• true：释放组内实例。
• false：保留组内实例。

默认值：false。

弹性供应组内抢占式实例的最高价格。

弹性供应组的目标总容量。取值范围：正整数。

总容量必须大于等于PayAsYouGoTargetCapacity（指定的按量付费实例目标容量）和SpotTargetCapacity（指定的抢占式实例目标容量）取值之和。

弹性供应组内，按量付费实例的目标容量。取值范围：小于等于TotalTargetCapacity的参数取值。

弹性供应组内，抢占式实例的目标容量。取值范围：小于等于TotalTargetCapacity的参数取值。

PayAsYouGoTargetCapacity和SpotTargetCapacity之和小于TotalTargetCapacity时，指定差额容量的计费方式。取值范围：

• PayAsYouGo：按量付费实例。
• Spot：抢占式实例。

默认值：Spot。

弹性供应组关联的实例启动模板的 ID，您可以调用 DescribeLaunchTemplates 查询可用的实例启动模板。同时指定启动模板与启动配置信息（LaunchConfiguration.*）时，优先使用启动模板。

弹性供应组关联的实例启动模板的版本，您可以调用 DescribeLaunchTemplateVersions 查询可用的实例启动模板版本。

默认值：启动模板的默认版本。

弹性供应组的描述信息。

保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。

镜像 ID。启动实例时选择的镜像资源，您可以调用 DescribeImages 查询可以使用的镜像资源。同时指定启动模板与启动配置信息时，优先使用启动模板。

实例所属的安全组 ID。同时指定启动模板与启动配置信息时，优先使用启动模板。

是否为 I/O 优化实例。取值范围：

• none：非 I/O 优化。
• optimized：I/O 优化。

已停售的实例规格实例默认值是 none，其他实例规格默认值是 optimized。

同时指定启动模板与启动配置信息时，优先使用启动模板。

网络计费类型。取值范围：

• PayByBandwidth：按固定带宽计费。
• PayByTraffic：按使用流量计费。

同时指定启动模板与启动配置信息时，优先使用启动模板。

公网入带宽最大值，单位为 Mbit/s。取值范围：

• 当公网出带宽小于等于 10 Mbit/s 时：1~10，默认为 10。
• 当公网出带宽大于 10 Mbit/s 时：1~LaunchConfiguration.InternetMaxBandwidthOut的取值，默认为LaunchConfiguration.InternetMaxBandwidthOut的取值。

同时指定启动模板与启动配置信息时，优先使用启动模板。

公网出带宽最大值，单位为 Mbit/s。取值范围：0~100。

默认值：0。

同时指定启动模板与启动配置信息时，优先使用启动模板。

实例名称。长度为 2~128 个字符，必须以大小写字母或中文开头，不能以http://和https://开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。

默认值：实例的InstanceId。

创建多台 ECS 实例时，您可以批量设置有序的实例名称。具体操作，请参见批量设置有序的实例名称或主机名称。

同时指定启动模板与启动配置信息时，优先使用启动模板。

实例主机名称。限制说明如下：

• 半角句号（.）和短划线（-）不能作为首尾字符，更不能连续使用。
• Windows 实例：字符长度为 2~15，不支持半角句号（.），不能全是数字。允许大小写英文字母、数字和短划线（-）。
• 其他类型实例（Linux 等）：字符长度为 2~64，支持多个半角句号（.），点之间为一段，每段允许大小写英文字母、数字和短划线（-）。
• 不支持同时设置LaunchConfiguration.HostName与LaunchConfiguration.HostNames.N，否则会返回报错信息。
• 同时指定启动模板与启动配置信息时，优先使用启动模板。

实例描述。长度为 2~256 个英文或中文字符，不能以http://和https://开头。同时指定启动模板与启动配置信息时，优先使用启动模板。

密钥对名称。

• Windows 实例，忽略该参数。默认为空。
• Linux 实例的密码登录方式会被初始化成禁止。

同时指定启动模板与启动配置信息时，优先使用启动模板。

实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。同时指定启动模板与启动配置信息时，优先使用启动模板。

是否开启安全加固。取值范围：

• Active：启用安全加固，只对公共镜像生效。
• Deactive：不启用安全加固，对所有镜像类型生效。

同时指定启动模板与启动配置信息时，优先使用启动模板。

实例自定义数据。需要以 Base64 方式编码，原始数据最多为 32 KB。同时指定启动模板与启动配置信息时，优先使用启动模板。

系统盘的云盘种类。取值范围：

• cloud_efficiency：高效云盘。
• cloud_ssd：SSD 云盘。
• cloud_essd：ESSD 云盘。
• cloud：普通云盘。

已停售的实例规格且非 I/O 优化实例默认值为 cloud，否则默认值为 cloud_efficiency。

同时指定启动模板与启动配置信息时，优先使用启动模板。

系统盘大小。单位为 GiB，取值范围：20~500。该参数的取值必须大于或者等于 max{20, LaunchConfiguration.ImageId 对应的镜像大小}。

默认值：max{40, 参数 LaunchConfiguration.ImageId 对应的镜像大小}。

同时指定启动模板与启动配置信息时，优先使用启动模板。

系统盘名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以http://和https://开头。可以包含数字、半角句号（.）、半角冒号（:）、下划线（_）或者短划线（-）。

默认值：空。

同时指定启动模板与启动配置信息时，优先使用启动模板。

系统盘的描述。长度为 2~256 个英文或中文字符，不能以http://和https://开头。

同时指定启动模板与启动配置信息时，优先使用启动模板。

创建 ESSD 云盘作为系统盘使用时，设置云盘的性能等级。取值范围：

• PL0（默认）：单盘最高随机读写 IOPS 1 万。
• PL1：单盘最高随机读写 IOPS 5 万。
• PL2：单盘最高随机读写 IOPS 10 万。
• PL3：单盘最高随机读写 IOPS 100 万。

有关如何选择 ESSD 性能等级，请参见 ESSD 云盘。

同时指定启动模板与启动配置信息时，优先使用启动模板。

是否使用镜像预设的密码。取值范围：

• true：使用。
• false：不使用。

同时指定启动模板与启动配置信息时，优先使用启动模板。

实例所在的企业资源组 ID。同时指定启动模板与启动配置信息时，优先使用启动模板。

设置突发性能实例的运行模式。取值范围：

• Standard：标准模式，实例性能请参见什么是突发性能实例下的性能约束模式章节。
• Unlimited：无性能约束模式，实例性能请参见什么是突发性能实例下的无性能约束模式章节。

默认值：无。

同时指定启动模板与启动配置信息时，优先使用启动模板。

实例的密码。长度为 8 至 30 个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：

()`~!@#$%^&*-_+=|{}`[]`:;'<>,.?/

其中，Windows 实例不能以正斜线（/）为密码首字符。

同时指定启动模板与启动配置信息时，优先使用启动模板。

部署集 ID。

扩展启动模板列表。

扩展启动模板云盘配置列表。

扩展启动模板标签列表。

实例系统盘信息列表。

实例数据盘信息列表。

为一台或多台实例指定不同的主机名称。限制说明如下：

• 仅创建一次性同步交付类型的弹性供应组（AutoProvisioningGroupType=instant）时，该参数生效。
• N 表示实例个数，取值范围为 1~1000，且需要和 TotalTargetCapacity 参数值保持一致。
• 半角句号（.）和短划线（-）不能作为首尾字符，更不能连续使用。
• Windows 实例：字符长度为 2~15，不支持半角句号（.），不能全是数字。允许包含大小写英文字母、数字和短划线（-）。
• 其他类型实例（Linux 等）：字符长度为 2~64，支持多个半角句号（.），半角句号（.）之间为一段，每段允许包含大小写英文字母、数字和短划线（-）。
• 不支持同时设置LaunchConfiguration.HostName与LaunchConfiguration.HostNames.N，否则会返回报错信息。
• 同时指定启动模板与启动配置信息时，优先使用启动模板。

弹性供应组的目标最小容量。取值范围：正整数。

当您设置该参数后，需要注意：

• 仅创建一次性同步交付类型的弹性供应组（AutoProvisioningGroupType=instant）时，该参数生效。
• 如果当前地域下的实例库存小于该参数值，则会导致调用接口失败，不会创建实例。
• 如果当前地域下的实例库存大于该参数值，则按照已设置的其他参数值正常创建实例。

实例所属的安全组列表。

实例的系统盘信息。同时指定启动模板与启动配置信息时，优先使用启动模板。

按量付费实例的自动释放时间。按照ISO 8601标准表示，使用 UTC+0 时间。格式为：yyyy-MM-ddTHH:mm:ssZ。

• 如果秒（ss）取值不是00，则自动取为当前分钟（mm）开始时。

• 最短释放时间为当前时间半小时之后。

• 最长释放时间不能超过当前时间三年。

镜像族系名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以aliyun和acs:开头，不能包含http://或者https://。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。

弹性供应组绑定的标签列表。

创建实例时使用的资源池策略。当您设置该参数后，需要注意：

• 该参数只在创建按量付费实例时生效。
• 仅创建一次性同步交付类型的弹性供应组（AutoProvisioningGroupType=instant）时，该参数生效。