文档

CreateAutoProvisioningGroup - 创建一个弹性供应组

更新时间:

调用CreateAutoProvisioningGroup接口创建一个弹性供应组。

接口说明

  • 弹性供应是一个使用抢占式实例和按量付费实例快速部署实例集群的方案,支持一键部署跨计费方式、跨可用区、跨实例规格族的实例集群。更多信息,请参见使用弹性供应组 API 批量创建 ECS 实例
  • 弹性供应以供应组为载体调度和维护计算资源,您可以通过弹性供应组稳定提供计算力,缓解抢占式实例的回收机制带来的不稳定因素。
  • 弹性供应为免费功能,但是您需要为通过弹性供应组创建出的实例资源付费。更多信息,请参见抢占式实例计费按量付费
  • 当您同时指定启动模板(LaunchTemplateId)与启动配置信息(LaunchConfiguration.*)时,系统优先使用启动模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:CreateAutoProvisioningGroupWrite
  • Fleet
    acs:ecs:{#regionId}:{#accountId}:fleet/*

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
ResourceGroupIdstring

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

rg-bp67acfmxazb4p****
AutoProvisioningGroupNamestring

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

apg-test
AutoProvisioningGroupTypestring

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

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

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

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

默认值:maintain。

maintain
SpotAllocationStrategystring

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

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

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

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

默认值:lowest-price。

diversified
SpotInstanceInterruptionBehaviorstring

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

  • stop:停止实例。

  • terminate:释放实例。

默认值:terminate。

terminate
SpotInstancePoolsToUseCountinteger

SpotAllocationStrategylowest-price时生效,表示弹性供应组选择价格最低的实例规格创建实例的数量。

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

2
PayAsYouGoAllocationStrategystring

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

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

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

默认值:lowest-price。

prioritized
ExcessCapacityTerminationPolicystring

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

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

默认值:no-termination。

termination
ValidFromstring

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

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

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

2019-04-01T15:10:20Z
ValidUntilstring

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

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

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

2019-06-01T15:10:20Z
TerminateInstancesWithExpirationboolean

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

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

默认值:false。

true
TerminateInstancesboolean

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

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

默认值:false。

true
MaxSpotPricefloat

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

说明 同时设置了MaxSpotPriceLaunchTemplateConfig.N.MaxPrice时,以最低值为准。
2
TotalTargetCapacitystring

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

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

60
PayAsYouGoTargetCapacitystring

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

30
SpotTargetCapacitystring

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

20
DefaultTargetCapacityTypestring

PayAsYouGoTargetCapacitySpotTargetCapacity之和小于TotalTargetCapacity时,指定差额容量的计费方式。取值范围:

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

默认值:Spot。

Spot
LaunchTemplateIdstring

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

lt-bp1fgzds4bdogu03****
LaunchTemplateVersionstring

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

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

1
Descriptionstring

弹性供应组的描述信息。

testDescription
ClientTokenstring

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

0c593ea1-3bea-11e9-b96b-88e9fe637760
LaunchConfiguration.ImageIdstring

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

m-bp1g7004ksh0oeuc****
LaunchConfiguration.SecurityGroupIdstring

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

sg-bp15ed6xe1yxeycg****
LaunchConfiguration.IoOptimizedstring

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

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

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

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

optimized
LaunchConfiguration.InternetChargeTypestring

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

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。
说明 按使用流量计费模式下的出入带宽峰值都是带宽上限,不作为业务承诺指标。当出现资源争抢时,带宽峰值可能会受到限制。如果您的业务需要有带宽的保障,请使用按固定带宽计费模式。

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

PayByTraffic
LaunchConfiguration.InternetMaxBandwidthIninteger

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

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

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

10
LaunchConfiguration.InternetMaxBandwidthOutinteger

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

默认值:0。

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

10
LaunchConfiguration.InstanceNamestring

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

默认值:实例的InstanceId

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

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

k8s-node-[1,4]-alibabacloud
LaunchConfiguration.HostNamestring

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

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

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

Instance_Description
LaunchConfiguration.KeyPairNamestring

密钥对名称。

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

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

KeyPair_Name
LaunchConfiguration.RamRoleNamestring

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

RAM_Name
LaunchConfiguration.SecurityEnhancementStrategystring

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

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

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

Active
LaunchConfiguration.UserDatastring

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

ZWNobyBoZWxsbyBlY3Mh
LaunchConfiguration.SystemDiskCategorystring

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

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

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

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

cloud_ssd
LaunchConfiguration.SystemDiskSizeinteger

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

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

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

40
LaunchConfiguration.SystemDiskNamestring

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

默认值:空。

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

cloud_ssdSystem
LaunchConfiguration.SystemDiskDescriptionstring

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

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

SystemDisk_Description
LaunchConfiguration.SystemDiskPerformanceLevelstring

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

  • PL0(默认):单盘最高随机读写 IOPS 1 万。
  • PL1:单盘最高随机读写 IOPS 5 万。
  • PL2:单盘最高随机读写 IOPS 10 万。
  • PL3:单盘最高随机读写 IOPS 100 万。

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

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

PL0
LaunchConfiguration.PasswordInheritboolean

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

  • true:使用。
  • false:不使用。

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

true
LaunchConfiguration.ResourceGroupIdstring

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

rg-bp67acfmxazb4p****
LaunchConfiguration.CreditSpecificationstring

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

默认值:无。

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

Standard
LaunchConfiguration.Passwordstring

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

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

其中,Windows 实例不能以正斜线(/)为密码首字符。

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

EcsV587!
LaunchConfiguration.DeploymentSetIdstring

部署集 ID。

ds-bp1frxuzdg87zh4p****
LaunchTemplateConfigobject []

扩展启动模板列表。

VSwitchIdstring

扩展启动模板中,ECS 实例加入的虚拟交换机的 ID。扩展模板中启动的 ECS 实例的可用区由虚拟交换机决定。

说明 设置了LaunchTemplateConfig后,LaunchTemplateConfig.N.VSwitchId为必选参数。
vsw-sn5bsitu4lfzgc5o7****
MaxPricedouble

扩展启动模板中,抢占式实例的价格上限。

说明 设置了LaunchTemplateConfig后,LaunchTemplateConfig.N.MaxPrice为必选参数。
3
Priorityinteger

扩展启动模板的优先级,取值为 0 时优先级最高。取值范围:0 ~ +∞。

1
InstanceTypestring

扩展启动模板对应的实例规格,N 的取值范围:1~20。取值范围:请参见实例规格族

ecs.g5.large
WeightedCapacitydouble

扩展启动模板中,实例规格的权重。取值越高,单台实例满足计算力需求的能力越大,所需的实例数量越小。取值范围:大于 0。

您可以根据指定实例规格的计算力和集群单节点最低计算力得出权重值。假设单节点最低计算力为 8 vCPU、60 GiB,则:

  • 8 vCPU、60 GiB 的实例规格权重可以设置为 1。
  • 16 vCPU、120 GiB 的实例规格权重可以设置为 2。
2
MaxQuantityinteger
说明 该参数正在邀测中,暂不支持使用。
false
Coresarray

实例规格的 vCPU 内核数目列表。

integer

实例规格的 vCPU 内核数目,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族。N 的取值范围:1~10。

2
Memoriesarray

实例规格的内存大小列表。

float

实例规格的内存大小,单位为 GiB,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族。N 的取值范围:1~10。

4
InstanceFamilyLevelstring

实例规格族级别,用于筛选符合要求的实例规格范围。取值范围:

  • EntryLevel:入门级,即共享型实例规格。成本更低,但是无法保证实例计算性能的稳定。适用于平时 CPU 使用率低的业务场景。更多信息,请参见共享型
  • EnterpriseLevel:企业级。性能稳定,资源独享,适用于对稳定性要求高的业务场景。更多信息,请参见实例规格族
  • CreditEntryLevel:积分入门级,即突发性能实例。通过 CPU 积分来保证计算性能,适用于平时 CPU 使用率低、偶有突发 CPU 使用率的情况。更多信息,请参见突发性能实例

N 的取值范围:1~10。

EnterpriseLevel
ExcludedInstanceTypesarray

需要排除的实例规格列表。

string

需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:

  • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
  • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
ecs.n1.small/ecs.n1.*/*7*
Architecturesarray

实例规格所属的架构类型列表。

string

实例规格所属的架构类型。取值范围:

  • X86:X86 计算。
  • Heterogeneous:异构计算,例如 GPU 或 FPGA 等。
  • BareMental:弹性裸金属服务器。
  • Arm:Arm 计算。
  • SuperComputeCluster:超级计算集群。

默认值:包含所有架构类型。

X86
BurstablePerformancestring

是否为性能突发实例规格。取值范围:

  • Exclude:不包含性能突发实例规格。
  • Include:包含性能突发实例规格。
  • Required:只包含性能突发实例规格。

默认值:Include。

Include
LaunchConfiguration.DataDiskobject []

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

PerformanceLevelstring

创建 ESSD 云盘作为数据盘使用时,设置云盘的性能等级。N 的取值必须和LaunchConfiguration.DataDisk.N.Category中的 N 保持一致。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万。
  • PL1(默认):单盘最高随机读写 IOPS 5 万。
  • PL2:单盘最高随机读写 IOPS 10 万。
  • PL3:单盘最高随机读写 IOPS 100 万。

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

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

PL1
KmsKeyIdstring

数据盘对应的 KMS 密钥 ID。同时指定启动模板与启动配置信息时,优先使用启动模板。

0e478b7a-4262-4802-b8cb-00d3fb40****
Descriptionstring

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

DataDisk_Description
SnapshotIdstring

创建数据盘 N 使用的快照。N 的取值范围为 1~16。

指定该参数后,参数LaunchConfiguration.DataDisk.N.Size会被忽略,实际创建的云盘大小为指定的快照的大小。不能使用早于 2013 年 7 月 15 日(含)创建的快照,请求会报错被拒绝。

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

s-bp17441ohwka0yuh****
Sizeinteger

第 N 个数据盘的容量大小,N 的取值范围为 1~16,单位为 GiB。取值范围:

  • cloud_efficiency:20~32768。
  • cloud_ssd:20~32768。
  • cloud_essd:具体取值范围与LaunchConfiguration.DataDisk.N.PerformanceLevel的取值有关。
    • PL0:40~32768。
    • PL1:20~32768。
    • PL2:461~32768。
    • PL3:1261~32768
  • cloud:5~2000。
说明 该参数的取值必须大于等于参数LaunchConfiguration.DataDisk.N.SnapshotId指定的快照的大小。

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

20
Devicestring

数据盘的挂载点。同时指定启动模板与启动配置信息时,优先使用启动模板。

/dev/vd1
DiskNamestring

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

默认值:空。

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

cloud_ssdData
Categorystring

数据盘 N 的云盘类型。N 的取值范围为 1~16。取值范围:

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

对于 I/O 优化实例,默认值为 cloud_efficiency。对于非 I/O 优化实例,默认值为 cloud。

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

cloud_ssd
DeleteWithInstanceboolean

数据盘是否随实例释放。取值范围:

  • true:数据盘随实例释放。
  • false:数据盘不随实例释放。

默认值:true。

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

true
Encryptedboolean

数据盘 N 是否加密。取值范围:

  • true:加密。
  • false:不加密。

默认值:false。

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

false
LaunchConfiguration.Tagobject []

扩展启动模板标签列表。

Keystring

实例的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含http://https://。同时指定启动模板与启动配置信息时,优先使用启动模板。

TestKey
Valuestring

实例的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以 acs:开头,不能包含http://或者https://。同时指定启动模板与启动配置信息时,优先使用启动模板。

TestValue
SystemDiskConfigobject []

实例系统盘信息列表。

DiskCategorystring

实例系统盘类型。您可通过该参数指定多种候选磁盘类型,指定顺序作为各磁盘类型的优先级顺序,当某一种磁盘不可用时,自动更换磁盘类型。取值范围:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud:普通云盘。
cloud_ssd
DataDiskConfigobject []

实例数据盘信息列表。

DiskCategorystring

实例数据盘类型。您可通过该参数指定多种候选磁盘类型,指定顺序作为各磁盘类型的优先级顺序,当某一种磁盘不可用时,自动更换磁盘类型。取值范围:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud:普通云盘。
cloud_efficiency
LaunchConfiguration.HostNamesarray

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

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

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

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

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

当您设置该参数后,需要注意:

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

实例所属的安全组列表。

string

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

sg-bp15ed6xe1yxeycg****
LaunchConfiguration.SystemDiskobject

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

Encryptedstring

系统盘 N 是否加密。取值范围:

  • true:加密。

  • false:不加密。

默认值:false。

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

false
KMSKeyIdstring

系统盘对应的 KMS 密钥 ID。

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

0e478b7a-4262-4802-b8cb-00d3fb40****
EncryptAlgorithmstring

系统盘加密算法。取值范围:

  • aes-256。

  • sm4-128。

默认值:aes-256。

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

aes-256
LaunchConfiguration.Arnobject []

该参数暂未开放使用。

Rolearnstring

该参数暂未开放使用。

acs:ram::123456789012****:role/adminrole
RoleTypestring

该参数暂未开放使用。

34458433936495****:alice
AssumeRoleForlong

该参数暂未开放使用。

123456789012****
HibernationOptionsConfiguredboolean
说明 该参数正在邀测中,暂未开放使用。
false
LaunchConfiguration.AutoReleaseTimestring

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

  • 如果秒(ss)取值不是00,则自动取为当前分钟(mm)开始时。

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

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

2018-01-01T12:05:00Z
LaunchConfiguration.ImageFamilystring

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

hangzhou-daily-update
Tagobject []

弹性供应组绑定的标签。

Keystring

弹性供应组的标签键。

N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。

TestKey
Valuestring

弹性供应组的标签值。

N 的取值范围:1~20。一旦传入该值,允许为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。

TestValue

返回参数

名称类型描述示例值
object
AutoProvisioningGroupIdstring

弹性供应组的 ID。

apg-sn54avj8htgvtyh8****
RequestIdstring

请求 ID。

745CEC9F-0DD7-4451-9FE7-8B752F39****
LaunchResultsobject []

弹性供应组创建的实例组成的集合。该集合值仅当弹性供应组的交付类型为一次性同步交付(instant)时返回。

ZoneIdstring

实例所在的可用区 ID。

cn-hangzhou-g
ErrorMsgstring

当实例创建失败时,返回的错误信息。

Specific parameter is not valid.
InstanceTypestring

实例规格。

ecs.g5.large
ErrorCodestring

当实例创建失败时,返回的错误码。

InvalidParameter
SpotStrategystring

按量实例的抢占策略。可能值:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
NoSpot
Amountinteger

成功创建的实例 ID 列表内的实例数量。

1
InstanceIdsarray

成功创建的实例 ID 列表。

string

成功创建的实例 ID 列表。

["i-bp67acfmxazb4p****"]

示例

正常返回示例

JSON格式

{
  "AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
  "RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****",
  "LaunchResults": {
    "LaunchResult": [
      {
        "ZoneId": "cn-hangzhou-g",
        "ErrorMsg": "Specific parameter is not valid.",
        "InstanceType": "ecs.g5.large",
        "ErrorCode": "InvalidParameter",
        "SpotStrategy": "NoSpot",
        "Amount": 1,
        "InstanceIds": {
          "InstanceId": [
            "[\"i-bp67acfmxazb4p****\"]"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter%s无效的参数。
400InvalidAutoProvisioningGroupName.MalformedThe specified parameter "AutoProvisioningGroupName" is not valid.-
400InvalidAutoProvisioningGroupType.ValueNotSupportedThe specified parameter "AutoProvisioningGroupType" is not supported.-
400InvalidFleetExcessCapacityTerminationPolicy.ValueNotSupportedThe specified parameter "ExcessCapacityTerminationPolicy" is not supported.-
400InvalidDefaultTargetCapacityType.ValueNotSupportedThe specified parameter "DefaultTargetCapacityType" is not supported.-
400InvalidSpotAllocationStrategy.ValueNotSupportedThe specified parameter "SpotAllocationStrategy" is not supported.-
400InvalidSpotInstanceInterruptionBehavior.ValueNotSupportedThe specified parameter "SpotInstanceInterruptionBehavior" is not supported.-
400InvalidPayAsYouGoAllocationStrategy.ValueNotSupportedThe specified parameter "PayAsYouGoAllocationStrategy" is not supported.-
400MissingParameter.SpotAllocationStrategyThe specified parameter "SpotAllocationStrategy" is empty.-
400MissingParameter.LaunchTemplateConfigsThe specified parameter "LaunchTemplateConfigs" is empty.-
400InvalidValidTime.MalFormedThe specified parameter "ValidTime" is not supported.-
400InvalidLaunchTemplateVersion.ValueNotSupportedThe specified parameter "LaunchTemplateVersion" is not valid.-
400MissingParameterThe specified parameter "AutoProvisioningGroup" should not be null.-
400InvalidRegion.ValueNotSupportedThe specified Region does not exist.-
400InvalidDescription.ValueNotSupportedThe specified description is illegal.-
400MissingParameterThe specified launchTemplate does not exist.-
400InvalidLaunchTemplate.ValueNotSupportedThe SecurityGroupId or imageId in LaunchTemplate is not exists.-
400MissingParameterThe launchTemplateConfigs should not be null.-
400InvalidCapacity.ValueNotSupportedThe Capacity is illegal, or the TargetCapacity is large than SpotCapacity + PayAsYouGoCapacity.-
400MissingParameterThe specified parameter "instanceType" should not be null.-
400InvalidInstanceType.ValueNotSupportedThe instanceType is illegal.-
400MissingParameterThe specified parameter "VSWitchId" should not be null.-
400InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。
400InvalidLaunchTemplateConfigs.SizeExceedThe size of LaunchTemplateConfigs exceeds limit.-
400InvalidPayAsYouGoAllocationStrategy.ValueNotSupportedThe specified parameter "PayAsYouGoAllocationStrategy" is not valid.-
400InvalidSpotAllocationStrategy.ValueNotSupportedThe specified parameter "SpotAllocationStrategy" is not valid.-
400InvalidParameter.SpotInstancePoolsToUseCountThe specified parameter "SpotInstancePoolsToUseCount" is not valid.-
400InvalidParameter.ResourceGroupIdThe specified parameter "ResourceGroupId" is not valid.-
400InvalidParameter.TargetCapacityThe Capacity is illegal, TotalTargetCapacity, PayAsYouGoTargetCapacity, SpotTargetCapacity must be specified, meanwhile, the TargetCapacity must be larger than or equal to the sum of SpotCapacity and OnDemandCapacity.-
400MissingParameter.WeightedCapacityThe WeightedCapacity of LaunchTemplateConfig should not be empty.-
400InvalidParameter.WeightedCapacityBeyondRangeThe WeightedCaTpacity of LaunchTemplateConfig beyond permitted range.-
400InvalidParameter.MaxPriceThe specified parameter "MaxSpotPrice" or "MaxPrice" of LaunchTemplateConfig is not valid.-
400NoPermission%s-
400Duplicate.DiskCategoryThe specified disk configs contains duplicate DiskCategory.-
400MissingParameter%s缺失参数,请检查参数是否完整。
400InvalidVSwitchId.NotFound%s指定的交换机不存在。
400InvalidImageFamily.ConfictThe specified parameter ImageFamily should be empty when the parameter ImageId is specified.当填写镜像ID时,参数ImageFamily必须为空。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
2024-02-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Tag
2023-11-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:LaunchConfiguration.ImageFamily
2023-06-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-04-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:500
2022-09-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:HibernationOptionsConfigured
  • 本页导读 (1)