文档

RunInstances - 创建一台或多台按量付费或者包年包月ECS实例

更新时间:

调用RunInstances接口,并可以指定ImageId、InstanceType、SecurityGroupId、VSwitchId等参数,创建一台或多台按量付费或者包年包月ECS实例。

接口说明

  • 准备工作

  • 与 CreateInstance 对比差异

    和 CreateInstance 接口相比,RunInstances 接口有以下优点:

    • 单次最多可以创建 100 台实例,避免重复多次调用 CreateInstance。
    • 实例创建之后,实例会自动变成Starting状态,然后变成Running状态,不需要再调用 StartInstance 启动实例。
    • 创建实例时可以指定InternetMaxBandwidthOut为 ECS 实例分配公网 IP,不需要您再调用 AllocatePublicIpAddress 分配公网 IP。
    • 您可以指定AutoReleaseTime参数来设定自动释放时间,不需要再调用 ModifyInstanceAutoReleaseTime 设置自动释放时间。
    • 您可以指定LaunchTemplateIdLaunchTemplateVersion使用启动模板,可以免除您每次创建实例时都需要填入大量配置参数。
    • 可以指定UniqueSuffix参数批量设置有序的实例名称或主机名称,方便管理与检索。
    • 使用 RunInstances 创建实例时支持设置 Enclave 机密计算模式和可信系统模式。
    • 可以指定 NetworkOptions.EnableJumboFrame参数为 true 在创建时开启 Jumbo frame 特性。 更多信息,请参见 ECS 实例 MTU
  • 注意事项

    • 单次最多能创建 100 台实例。

    • 您可以指定参数AutoReleaseTime设置实例自动释放时间。

    • 创建成功后会返回实例 ID 列表,您可以通过 DescribeInstances 查询新建实例状态。

    • 创建实例时,默认自动启动实例,直到实例状态变成运行中(Running)。

    • 自 2020 年 11 月 27 日起,创建和变配 ECS 实例时带宽峰值受账户限速策略影响。如需更大带宽峰值,请提交工单。具体限速策略:单个地域下,所有按使用流量计费 ECS 实例的实际运行带宽峰值总和不大于 5 Gbit/s;所有按固定带宽计费 ECS 实例的实际运行带宽峰值总和不大于 50 Gbit/s。

    • CreateInstance 相比,通过RunInstances创建的实例如果参数InternetMaxBandwidthOut的值大于 0,则自动为实例分配公网 IP。

    • RunInstances 支持以下任一方式绑定主网卡,但需要注意一次调用只能选用一种方式配置主网卡,同时使用两种方式将会调用失败并返回错误信息。

      • 通过SecurityGroupIdVSwitchIdPrivateIpAddressNetworkInterfaceQueueNumberIpv6AddressCount等参数直接设置主网卡的相关配置信息。
      • 通过NetworkInterface.N.*设置主网卡以及辅助网卡的配置信息。当NetworkInterface.N.InstanceType取值为Primary时,表示设置主网卡;当NetworkInterface.N.InstanceType取值为Secondary或空值时,表示设置辅助网卡。
    • 提交创建任务后,参数不合法或者库存不足的情况下会报错,具体的报错原因参见错误码。

      • 如果创建实例时返回QuotaExceed.ElasticQuota错误,表示您在当前地域选择的实例规格所要创建的台数超出系统限额,或者全实例规格 vCPU 配额超出系统限额,您可以前往 ECS 管理控制台配额中心申请提高限额。

      • 如果创建实例时返回QuotaExceed.DiskCapacity错误,表示您当前选择的磁盘类型所要创建的总容量超出指定可用区的系统限额,您可以前往配额中心查询和申请提高磁盘容量配额。

  • 最佳实践

    • 单次大批量创建 ECS 实例(大于 100 台)遇到库存不足的场景;对实例规格或可用区等资源配置无指定要求,更关注如何快速创建实例的场景;对 ECS 实例数量无指定要求,更关注总算力 vCPU 个数等场景下,阿里云推荐您使用弹性供应组。您可以通过 CreateAutoProvisioningGroup 创建弹性供应组,一键式地部署跨计费方式、跨可用区、跨实例规格族的实例集群。更多信息,请参见使用弹性供应组 API 批量创建 ECS 实例

    • RunInstances可以执行批量创建任务,为便于管理与检索,建议您为每批次启动的实例指定标签(Tag.N.KeyTag.N.Value),并且为主机名(HostName)和实例名称(InstanceName)添加有序后缀(UniqueSuffix)。

    • 实例启动模板能免除您每次创建实例时都需要填入大量配置参数,您可以创建实例启动模板( CreateLaunchTemplate )后,在RunInstances请求中指定LaunchTemplateIdLaunchTemplateVersion使用启动模板。

示例 1:创建包年包月实例

实例所在地域为华东 1(杭州),计费方式为包年包月,购买时长一个月,到期自动续费一个月,镜像 ID 为:aliyun_3_x64_20G_alibase_20221102.vhd,实例规格为:ecs.g7.large,40 GiB ESSD 云盘,挂载 100 GiB ESSD 云数据盘,公网出带宽为 10 Mbit/s,自动分配私网 IP 和公网 IP,实例名称为 ECS-test,登录密码为 ECS@test1234,数量为 1 台。

http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PrePaid
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&Amount=1
&Period=1
&PeriodUnit=Month
&AutoRenew=true
&AutoRenewPeriod=1
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&公共请求参数

示例 2:创建按量付费实例

实例所在地域为华东 1(杭州),计费方式为按量付费,镜像 ID 为:aliyun_3_x64_20G_alibase_20221102.vhd,实例规格为:ecs.g7.large,40 GiB ESSD 云盘,挂载 100 GiB ESSD 云数据盘,公网出带宽为 10 Mbit/s,自动分配私网 IP 和公网 IP,实例名称为 ECS-test,登录密码为 ECS@test1234,数量为 1 台。

http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PostPaid
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&公共请求参数

示例 3:创建抢占式实例

实例所在地域为华东 1(杭州),计费方式为抢占式实例,竞价策略为系统自动出价,跟随当前市场实际价格,实例保留时长为 1 小时,镜像 ID 为:aliyun_3_x64_20G_alibase_20221102.vhd,实例规格为:ecs.g7.large,40 GiB ESSD 云盘,挂载 100 GiB ESSD 云数据盘,公网出带宽为 10 Mbit/s,自动分配私网 IP 和公网 IP,实例名称为 ECS-test,登录密码为 ECS@test1234,数量为 1 台。

http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PostPaid
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&SpotStrategy=SpotAsPriceGo
&SpotDuration=1
&公共请求参数

示例 4:在专有宿主机上创建包年包月实例

实例所在地域为华东 1(杭州),专有宿主机为 dh-bp12w10wll9xcjq2****,计费方式包年包月,购买时长一个月,镜像 ID 为:aliyun_3_x64_20G_alibase_20221102.vhd,实例规格为:ecs.g7.large,40 GiB ESSD 云盘,挂载 100 GiB ESSD 云数据盘,公网出带宽为 10 Mbit/s,自动分配私网 IP 和公网 IP,实例名称为 ECS-test,登录密码为 ECS@test1234,购买数量为 1 台。

http(s)://ecs.aliyuncs.com/?Action=RunInstances
&RegionId=cn-hangzhou
&ImageId=aliyun_3_x64_20G_alibase_20221102.vhd
&InstanceType=ecs.g7.large
&SecurityGroupId=sg-bp150uqocpf9jj70****
&VSwitchId=vsw-bp1qo7s91cbch5i4l****
&InstanceChargeType=PrePaid
&Amount=1
&Period=1
&PeriodUnit=Month
&SystemDisk.Size=40
&DataDisk.1.Size=100
&DataDisk.1.Category=cloud_essd
&SystemDisk.Category=cloud_essd
&HostName=ECS-test
&Password=ECS@test1234
&InternetMaxBandwidthOut=10
&DedicatedHostId=dh-bp12w10wll9xcjq2****
&公共请求参数

调试

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

授权信息

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

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

请求参数

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

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ImageIdstring

镜像 ID,启动实例时选择的镜像资源。您可以通过 DescribeImages 查询您可以使用的镜像资源。如果您不指定LaunchTemplateIdLaunchTemplateName以确定启动模板,也不通过指定ImageFamily选用镜像族系最新可用镜像,则ImageId为必选参数。

aliyun_2_1903_x64_20G_alibase_20200324.vhd
ImageFamilystring

镜像族系名称,通过设置该参数来获取当前镜像族系内最新可用镜像来创建实例。

镜像族系的名称长度为 2~128 个字符。镜像族系名称不能以特殊字符、数字、http://、https://开头,只可包含特殊字符中的"."、"_"、"-"和":"。

您需要注意:

  • 设置了参数ImageId,则不能设置该参数。
  • 未设置参数ImageId,但指定的LaunchTemplateIdLaunchTemplateName对应的启动模板设置了ImageId,则不能设置该参数。
  • 未设置ImageId,且指定的LaunchTemplateIdLaunchTemplateName对应的启动模板未设置ImageId,则可以设置该参数。
  • 未设置ImageId,且未设置LaunchTemplateIdLaunchTemplateName参数,则可以设置该参数。
说明 阿里云官方镜像关联的镜像族系信息请参见公共镜像概述
hangzhou-daily-update
InstanceTypestring

实例的资源规格。如果您不指定LaunchTemplateIdLaunchTemplateName以确定启动模板,InstanceType为必选参数。

ecs.g6.large
SecurityGroupIdstring

新创建实例所属于的安全组 ID。同一个安全组内的实例之间可以互相访问,一个安全组能容纳的实例数量视安全组类型而定,具体请参见使用限制的安全组章节。

说明 SecurityGroupId决定了实例的网络类型,例如,如果设置的安全组的网络类型为专有网络 VPC,实例则为 VPC 类型,并同时需要指定参数VSwitchId

如果您不设置LaunchTemplateIdLaunchTemplateName以确定实例启动模板,则安全组 ID 为必选参数。您需要注意:

  • 您可以通过SecurityGroupId设置一个安全组,也可以通过SecurityGroupIds.N设置一个或多个安全组,但不支持同时设置SecurityGroupIdSecurityGroupIds.N

  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置SecurityGroupIdSecurityGroupIds.N,只能设置NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N

sg-bp15ed6xe1yxeycg7****
VSwitchIdstring

虚拟交换机 ID。如果您创建的是 VPC 类型 ECS 实例,必须指定虚拟交换机 ID,且安全组和虚拟交换机在同一个专有网络 VPC 中。您可以调用 DescribeVSwitches 查询已创建的交换机的相关信息。

您需要注意:

  • 如果您设置了VSwitchId参数,则设置的ZoneId参数必须和交换机所在的可用区保持一致。您也可以不设置ZoneId参数,系统将自动选择指定交换机所在的可用区。

  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置VSwitchId,只能设置NetworkInterface.N.VSwitchId

vsw-bp1s5fnvk4gn2tws0****
InstanceNamestring

实例名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。默认值为实例的InstanceId

创建多台 ECS 实例时,您可以批量设置有序的实例名称,并且可以包含方括号([])和逗号(,)。具体操作,请参见批量设置有序的实例名称或主机名称

k8s-node-[1,4]-alibabacloud
Descriptionstring

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

Instance_Description
InternetMaxBandwidthIninteger

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

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

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

默认值:0。

10
HostNamestring

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

  • 半角句号(.)和短划线(-)不能作为首尾字符,更不能连续使用。
  • Windows 实例:字符长度为 2~15,不支持半角句号(.),不能全是数字。允许包含大小写英文字母、数字和短划线(-)。
  • 其他类型实例(Linux 等):
    • 字符长度为 2~64,支持多个半角句号(.),点之间为一段,每段允许包含大小写英文字母、数字和短划线(-)。
    • 支持通过占位符${instance_id}将实例 ID 写入HostName参数。例如:HostName=k8s-${instance_id},并且创建的 ECS 实例 ID 为i-123abc****,则该实例的主机名为k8s-i-123abc****

创建多台 ECS 实例时,您可以:

  • 批量设置有序的主机名。具体操作,请参见批量设置有序的实例名称或主机名称
  • 通过HostNames.N参数,为多台实例分别设置主机名。需要注意HostName参数和HostNames.N参数不能同时设置。
k8s-node-[1,4]-ecshost
UniqueSuffixboolean

当创建多台实例时,是否为HostNameInstanceName自动添加有序后缀。有序后缀从 001 开始递增,最大不能超过 999。取值范围:

  • true:添加。
  • false:不添加。

默认值:false。

HostNameInstanceName按照指定排序格式设置,未设置命名后缀name_suffix,即命名格式为name_prefix[begin_number,bits]时,UniqueSuffix不生效,名称仅按照指定顺序排序。

更多信息,请参见批量设置有序的实例名称或主机名称

true
Passwordstring

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

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

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

说明 如果传入Password参数,建议您使用 HTTPS 协议发送请求,避免密码泄露。
EcsV587!
PasswordInheritboolean

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

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

默认值:false。

说明 使用该参数时,Password 参数必须为空,同时您需要确保使用的镜像已经设置了密码。
false
ZoneIdstring

实例所属的可用区 ID,您可以调用 DescribeZones 获取可用区列表。

说明 如果您指定了VSwitchId参数,则指定的ZoneId参数必须和交换机所在的可用区保持一致。您也可以不指定ZoneId参数,系统将自动选择指定的交换机所在的可用区。

默认值:系统自动选择。

cn-hangzhou-g
InternetChargeTypestring

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

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

默认值:PayByTraffic。

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

系统盘大小,单位为 GiB。取值范围:

  • 普通云盘:20~500。
  • ESSD 云盘:
    • PL0:1~2048。
    • PL1:20~2048。
    • PL2:461~2048。
    • PL3:1261~2048。
  • ESSD AutoPL 云盘:1~2048。
  • 其他云盘类型:20~2048。

该参数的取值必须大于或者等于 max{1, ImageSize}。

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

40
SystemDisk.Categorystring

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

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud:普通云盘。
  • cloud_auto:ESSD AutoPL 云盘。
  • cloud_essd_entry:ESSD Entry 云盘。
说明 仅当InstanceType设置为通用算力型实例规格族 u1ecs.u1)或经济型实例规格族 eecs.e)时,该参数支持取cloud_essd_entry值。

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

cloud_ssd
SystemDisk.DiskNamestring

系统盘名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

cloud_ssdSystem
SystemDisk.Descriptionstring

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

SystemDisk_Description
SystemDisk.PerformanceLevelstring

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

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

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

PL0
SystemDisk.AutoSnapshotPolicyIdstring

系统盘采用的自动快照策略 ID。

sp-bp67acfmxazb4p****
IoOptimizedstring

是否为 I/O 优化实例。已停售的实例规格实例默认值是 none,其他实例规格默认值是 optimized。取值范围:

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

实例自定义数据。必须填写已采用 Base64 编码后的数据,且在进行 Base64 编码前自定义数据内容的大小不能超过 32 KB。

有关实例自定义数据的使用限制、格式以及运行频率的详细信息,请参见实例自定义数据

说明 为保证传输过程中 UserData 的安全性,请避免直接以明文形式传送敏感数据,如密码和私钥。若需传送此类信息,建议先行加密处理,并采用 Base64 编码方式,随后在实例内部进行解密以确保信息安全。
ZWNobyBoZWxsbyBlY3Mh
KeyPairNamestring

密钥对名称。

说明 Windows 实例,忽略该参数。默认为空。即使填写了该参数,仍旧只执行Password的内容。
KeyPair_Name
RamRoleNamestring

实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。

RAM_Name
Amountinteger

指定创建 ECS 实例的数量。取值范围:1~100。

创建成功的 ECS 数量与指定的 Amount 和 minAmount 数量有关:

  • 不指定 minAmount 时:按照 Amount 数量创建,库存不满足则 API 返回创建失败,同时一台也不会创建。

  • 指定 minAmount 时:

    • 当 ECS 库存数量<minAmount:不会创建 ECS,同时 API 返回创建失败。
    • 当 minAmount≤ECS 库存数量<Amount,按照库存数量创建实例,API 返回创建成功。
    • 当 ECS 库存数量≥Amount,按照指定的 Amount 创建,API 返回创建成功。

默认值:1。

3
MinAmountinteger

指定 ECS 实例最小购买数量。取值范围:1~100。

创建成功的 ECS 数量与指定的 Amount 和 minAmount 数量有关:

  • 不指定 minAmount 时:按照 Amount 数量创建,库存不满足则 API 返回创建失败,同时一台也不会创建。

  • 指定 minAmount 时:

    • 当 ECS 库存数量<minAmount:不会创建 ECS,同时 API 返回创建失败。
    • 当 minAmount≤ECS 库存数量<Amount,按照库存数量创建实例,API 返回创建成功。
    • 当 ECS 库存数量≥Amount,按照指定的 Amount 创建,API 返回创建成功。
2
AutoReleaseTimestring

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

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

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

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

2018-01-01T12:05:00Z
SpotStrategystring

按量付费实例的竞价策略。当参数InstanceChargeType取值为PostPaid时生效。取值范围:

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

默认值:NoSpot。

NoSpot
SpotDurationinteger

抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:

  • 1:创建后阿里云会保证实例运行 1 小时不会被自动释放;超过 1 小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。
  • 0:创建后,阿里云不保证实例运行 1 小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。

实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。

1
SpotPriceLimitfloat

设置实例的每小时最高价格。支持最大 3 位小数,参数SpotStrategy取值为SpotWithPriceLimit时生效。

0.97
SpotInterruptionBehaviorstring

抢占实例中断模式。取值范围:

默认值:Terminate。

Terminate
SecurityEnhancementStrategystring

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

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

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

123e4567-e89b-12d3-a456-426655440000
HpcClusterIdstring

实例所属的 HPC 集群 ID。

创建 SCC 实例时,该参数为必选参数。您可以参考 CreateHpcCluster 创建 HPC 集群。

hpc-bp67acfmxazb4p****
DryRunboolean

是否只预检此次请求。取值范围:

  • true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和 ECS 库存。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认):发送正常请求,通过检查后直接创建实例。
false
DedicatedHostIdstring

是否在专有宿主机上创建 ECS 实例。由于专有宿主机不支持创建抢占式实例,指定DedicatedHostId参数后,会自动忽略请求中的SpotStrategySpotPriceLimit设置。

您可以通过 DescribeDedicatedHosts 查询专有宿主机 ID 列表。

dh-bp67acfmxazb4p****
LaunchTemplateIdstring

启动模板 ID。更多信息,请调用 DescribeLaunchTemplates

使用启动模板创建实例时,您必须指定LaunchTemplateIdLaunchTemplateName确定启动模板。

lt-bp1apo0bbbkuy0rj****
LaunchTemplateNamestring

启动模板名称。

使用启动模板创建实例时,您必须指定LaunchTemplateIdLaunchTemplateName确定启动模板。

LaunchTemplate_Name
LaunchTemplateVersionlong

启动模板版本。如果您指定了LaunchTemplateIdLaunchTemplateName而不指定启动模板版本号,则采用默认版本。

3
ResourceGroupIdstring

实例所在的企业资源组 ID。

rg-bp67acfmxazb4p****
Periodinteger

购买资源的时长,单位由PeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。一旦指定了DedicatedHostId,则取值范围不能超过专有宿主机的订阅时长。取值范围:

  • PeriodUnit=Week 时,Period 取值:1、2、3、4。
  • PeriodUnit=Month 时,Period 取值:1、2、3、4、5、6、7、8、9、12、24、36、48、60。
1
PeriodUnitstring

包年包月计费方式的时长单位。取值范围:

  • Week。
  • Month(默认)。
Month
AutoRenewboolean

是否要自动续费。当参数InstanceChargeType取值PrePaid时才生效。取值范围:

  • true:自动续费。
  • false:不自动续费。

默认值:false。

true
AutoRenewPeriodinteger

单次自动续费的续费时长。取值范围:

  • PeriodUnit=Week 时:1、2、3。
  • PeriodUnit=Month 时:1、2、3、6、12、24、36、48、60。

默认值:1。

1
InstanceChargeTypestring

实例的付费方式。取值范围:

  • PrePaid:包年包月。
  • PostPaid:按量付费。

默认值:PostPaid。

选择包年包月时,您必须确认自己的账号支持余额支付或者信用支付,否则将返回InvalidPayMethod的错误提示。

PrePaid
DeploymentSetIdstring

部署集 ID。

ds-bp1brhwhoqinyjd6****
DeploymentSetGroupNointeger

如果您设置的部署集对应的策略为部署集组高可用策略(AvailabilityGroup),可以通过该参数指定实例在部署集中的分组号。取值范围:1~7。

1
PrivateIpAddressstring

实例私网 IP 地址。专有网络 VPC 类型 ECS 实例设置私网 IP 地址时,必须从虚拟交换机(VSwitchId)的空闲网段中选择。

您需要注意:

  • 设置PrivateIpAddress后:

    • 如果Amount参数取值为 1,则表示为创建的一台 ECS 实例分配私网 IP 地址。
    • 如果Amount参数取值大于 1,则表示在批量创建 ECS 实例时,以指定的私网 IP 地址为起始地址,依次为多台 ECS 实例分配连续的私网 IP 地址,但需要注意,此时不支持再为实例绑定辅助网卡(即不支持再设置NetworkInterface.N.*这类参数)。
  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置PrivateIpAddress,只能设置NetworkInterface.N.PrimaryIpAddress

说明 每个交换机的第 1 个和最后 3 个 IP 地址为系统保留地址,不支持指定。 例如,交换机的网段为 192.168.1.0/24,则 192.168.1.0、192.168.1.253、192.168.1.254 和 192.168.1.255 这 4 个地址是系统保留地址。
10.1.**.**
CreditSpecificationstring

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

Standard
Ipv6AddressCountinteger

为主网卡指定随机生成的 IPv6 地址数量。取值范围:1~10。

您需要注意:

  • 您不能同时设置Ipv6Address.NIpv6AddressCount

  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置Ipv6Address.NIpv6AddressCount,只能设置NetworkInterface.N.Ipv6Address.NNetworkInterface.N.Ipv6AddressCount

1
NetworkInterfaceQueueNumberinteger

主网卡队列数。您需要注意:

  • 不能超过实例规格允许的单块网卡最大队列数。

  • 实例的所有网卡累加队列数不能超过实例规格允许的队列数总配额。实例规格的单块网卡最大队列数和总配额可以通过 DescribeInstanceTypes 接口查询MaximumQueueNumberPerEniTotalEniQueueQuantity字段。

  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置NetworkInterfaceQueueNumber,只能设置NetworkInterface.N.QueueNumber

8
DeletionProtectionboolean

实例释放保护属性,指定是否支持通过控制台或 API( DeleteInstance )释放实例。取值范围:

  • true:开启实例释放保护。
  • false:关闭实例释放保护。

默认值:false。

说明 该属性仅适用于按量付费实例,且只能限制手动释放操作,对系统释放操作不生效。
false
HibernationOptions.Configuredboolean
说明 该参数正在邀测中,暂未开放使用。
false
Affinitystring

专有宿主机实例是否与专有宿主机关联。取值范围:

  • default:实例不与专有宿主机关联。已启用节省停机模式的实例,停机后再次启动时,若原专有宿主机可用资源不足,则实例被放置在自动部署资源池的其它专有宿主机上。

  • host:实例与专有宿主机关联。已启用节省停机模式的实例,停机后再次启动时,仍放置在原专有宿主机上。若原专有宿主机可用资源不足,则实例重启失败。

默认值:default。

default
Tenancystring

是否在专有宿主机上创建实例。取值范围:

  • default:创建非专有宿主机实例。

  • host:创建专有宿主机实例。若您不指定DedicatedHostId,则由阿里云自动选择专有宿主机放置实例。

默认值:default。

default
StorageSetIdstring

存储集 ID。

ss-bp67acfmxazb4p****
StorageSetPartitionNumberinteger

存储集中的最大分区数量。取值范围:大于等于 2。

2
CpuOptions.Coreinteger

CPU 核心数。该参数不支持自定义设置,只能采用默认值。

默认值:请参见自定义 CPU 选项

2
CpuOptions.ThreadsPerCoreinteger

CPU 线程数。ECS 实例的 vCPU 数=CpuOptions.Core取值*CpuOptions.ThreadsPerCore取值。

  • CpuOptions.ThreadsPerCore=1表示关闭 CPU 超线程。

  • 仅部分实例规格支持设置 CPU 线程数。

取值范围和默认值:请参见自定义 CPU 选项

2
CpuOptions.Numastring

该参数已弃用。

1
CpuOptions.TopologyTypestring

实例的 Cpu 拓扑类型。取值范围:

  • ContinuousCoreToHTMapping:当选择ContinuousCoreToHTMapping时,实例的 Cpu 拓扑中,实例的同一个 Core 的 HT 是连续的。
  • DiscreteCoreToHTMapping:当选择DiscreteCoreToHTMapping时,实例的同一个 Core 的 HT 是离散的。

默认值:无。

说明 仅部分实例规格族支持使用本参数,具体支持实例规格族请参见查看和修改 CPU 拓扑结构
DiscreteCoreToHTMapping
SecurityOptions.TrustedSystemModestring

可信系统模式。取值:vTPM。

目前,可信系统模式支持的实例规格族:

  • g7、c7、r7。
  • 安全增强型(g7t、c7t、r7t)。

当您创建以上实例规格族的 ECS 实例时,需要设置该参数。具体说明如下:

  • 如果您使用阿里云可信系统,请将该参数值设置为 vTPM,在实例启动时即可通过阿里云可信系统完成可信校验。
  • 如果您不使用阿里云可信系统,可以不设置该参数值,但您需要注意,如果您所创建的 ECS 实例使用了 Enclave 机密计算模式(SecurityOptions.ConfidentialComputingMode=Enclave),则该 ECS 实例也会启用可信系统。
  • 通过 OpenAPI 创建可信系统的 ECS 实例时,只能调用RunInstances实现,CreateInstance目前不支持设置SecurityOptions.TrustedSystemMode参数。
说明 如果您在创建实例的时候指定其为可信实例,那么当您更换系统盘时只能使用支持可信系统的镜像。

关于可信系统的更多信息,请参见安全增强型实例可信功能概述

vTPM
SecurityOptions.ConfidentialComputingModestring

机密计算模式。取值:Enclave。

该参数取值为 Enclave 时,表示 ECS 实例使用 Enclave 构建机密计算环境。目前仅实例规格族 c7、g7、r7,支持调用RunInstances时指定该参数使用 Enclave 机密计算。您需要注意:

  • 机密计算功能正在邀测中。

  • 通过 OpenAPI 创建 Enclave 机密计算的 ECS 实例时,只能调用RunInstances实现,CreateInstance目前不支持设置SecurityOptions.ConfidentialComputingMode参数。

  • Enclave 机密计算依托可信系统(vTPM)实现,当您指定 ECS 实例使用 Enclave 构建机密计算环境时,该实例同时也会启用可信系统。因此,调用该接口时,如果设置了SecurityOptions.ConfidentialComputingMode=Enclave,则无论您是否设置了SecurityOptions.TrustedSystemMode=vTPM,最终创建的 ECS 实例均会启用 Enclave 机密计算模式以及可信系统。

关于机密计算的更多信息,请参见使用 Enclave 构建机密计算环境

Enclave
HttpEndpointstring

是否启用实例元数据的访问通道。取值范围:

  • enabled:启用。
  • disabled:禁用。

默认值:enabled。

说明 有关实例元数据的信息,请参见实例元数据概述
enabled
HttpTokensstring

访问实例元数据时是否强制使用加固模式(IMDSv2)。取值范围:

  • optional:不强制使用。
  • required:强制使用。设置该取值后,普通模式无法访问实例元数据。

默认值:optional。

说明 有关访问实例元数据的模式,请参见实例元数据访问模式
optional
HttpPutResponseHopLimitinteger

实例元数据请求所需的 HTTP PUT 响应跃点限制。取值范围:1~64。

默认值:1。

3
PrivatePoolOptions.MatchCriteriastring

实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值范围:

  • Open:开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。该模式下无需设置PrivatePoolOptions.Id参数。
  • Target:指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。该模式下必须指定私有池 ID,即PrivatePoolOptions.Id参数为必填项。
  • None:不使用模式。实例启动将不使用私有池容量。

默认值:None。

以下任一场景,实例启动的私有池容量选项只能取值None或不传值。

  • 创建抢占式实例。
  • 创建经典网络类型的 ECS 实例。
  • 在专有宿主机 DDH 上创建 ECS 实例。
Open
PrivatePoolOptions.Idstring

私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。

eap-bp67acfmxazb4****
Ispstring
说明 该参数正在邀测中,暂未开放使用。
null
SchedulerOptions.DedicatedHostClusterIdstring

指定 ECS 实例所属的专有宿主机集群,系统会自动选择该专有宿主机集群中的一台专有宿主机部署 ECS 实例。

说明 仅在Tenancy设置为host时生效。

在您同时指定了专有宿主机(DedicatedHostId)和专有宿主机集群(SchedulerOptions.DedicatedHostClusterId)时:

  • 如果专有宿主机属于专有宿主机集群,则优先将 ECS 实例部署在指定的专有宿主机上。
  • 如果专有宿主机不属于专有宿主机集群,则 ECS 实例创建失败。

您可以通过 DescribeDedicatedHostClusters 查询专有宿主机集群 ID 列表。

dc-bp12wlf6am0vz9v2****
SecurityGroupIdsarray

将实例同时加入多个安全组。N 的取值范围与实例能够加入安全组配额有关。更多信息,请参见安全组限制

您需要注意:

  • 不支持同时设置SecurityGroupIdSecurityGroupIds.N
  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置SecurityGroupIdSecurityGroupIds.N,只能设置NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
string

将实例同时加入多个安全组。N 的取值范围与实例能够加入安全组配额有关。更多信息,请参见安全组限制

您需要注意:

  • 不支持同时设置SecurityGroupIdSecurityGroupIds.N
  • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置SecurityGroupIdSecurityGroupIds.N,只能设置NetworkInterface.N.SecurityGroupIdNetworkInterface.N.SecurityGroupIds.N
sg-bp15ed6xe1yxeycg7****
HostNamesarray

创建多台实例时,为每台实例指定不同的主机名。

string

创建多台实例时,为每台实例指定不同的主机名。限制说明如下:

  • N 的个数需要和Amount参数值保持一致。例如,Amount=2时,通过该参数指定主机名的格式为HostNames.1=test1HostNames.2=test2
  • 不支持同时设置HostName参数和HostNames.N参数。
  • 半角句号(.)和短划线(-)不能作为首尾字符,更不能连续使用。
  • Windows 实例:字符长度为 2~15,不支持半角句号(.),不能全是数字。允许包含大小写英文字母、数字和短划线(-)。
  • 其他类型实例(Linux 等):字符长度为 2~64,支持多个半角句号(.),点之间为一段,每段允许包含大小写英文字母、数字和短划线(-)。
ecs-host-01
DataDiskarray<object>

数据盘信息集合列表。

object

数据盘信息集合。

PerformanceLevelstring

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

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

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

PL1
AutoSnapshotPolicyIdstring

数据盘采用的自动快照策略 ID。

sp-bp67acfmxazb4p****
Encryptedstring

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

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

默认值:false。

false
Descriptionstring

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

DataDisk_Description
SnapshotIdstring

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

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

s-bp17441ohwka0yuh****
Devicestring

数据盘的挂载点。挂载的数据盘数量不同,挂载点的命名不同:

  • 1~25 块数据盘:/dev/xvd[b-z]

  • 大于 25 块数据盘:/dev/xvd[aa-zz],例如第 26 块数据盘会被命名为/dev/xvdaa,第 27 块数据盘为/dev/xvdab,以此类推。

说明 该参数仅用于全镜像(整机镜像)场景。您可以通过将此参数设置为全镜像中数据盘对应的挂载点,并修改对应的DataDisk.N.SizeDataDisk.N.Category参数,达到修改全镜像中数据盘磁盘种类和大小的目的。
/dev/xvdb
Sizeinteger

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

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

数据盘名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

cloud_ssdData
Categorystring

数据盘 N 的云盘种类。取值范围:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud:普通云盘。
  • cloud_auto:ESSD AutoPL 云盘。
  • cloud_essd_entry:ESSD Entry 云盘。
    说明 仅当InstanceType设置为ecs.u1ecs.e规格族时,该参数支持cloud_essd_entry
  • elastic_ephemeral_disk_standard:弹性临时盘-标准版。
  • elastic_ephemeral_disk_premium:弹性临时盘-高级版。

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

cloud_ssd
EncryptAlgorithmstring
说明 该参数暂未开放使用。
null
DeleteWithInstanceboolean

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

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

默认值为 true。

true
KMSKeyIdstring

数据盘对应的 KMS 密钥 ID。

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

专属块存储集群 ID。如果您在创建 ECS 实例时,需要使用专属块存储集群中的云盘资源作为数据盘,请设置该参数。

dbsc-j5e1sf2vaf5he8m2****
ProvisionedIopslong

ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50000}。

说明 当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘
40000
BurstingEnabledboolean

是否开启 Burst(性能突发)。取值范围:

  • true:是。
  • false:否。
说明 当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘
false
Arnarray<object>
说明 该参数暂未开放使用。
object
说明 该参数暂未开放使用。
RoleTypestring
说明 该参数暂未开放使用。
null
Rolearnstring
说明 该参数暂未开放使用。
null
AssumeRoleForlong
说明 该参数暂未开放使用。
null
NetworkInterfacearray<object>

弹性网卡信息。

object

弹性网卡信息。

VSwitchIdstring

弹性网卡所属的虚拟交换机 ID。

您需要注意:

  • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。

  • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数。此时该参数的作用等同于VSwitchId,但需要注意不能同时设置VSwitchId参数。

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的虚拟交换机。

vsw-bp67acfmxazb4p****
NetworkInterfaceNamestring

弹性网卡名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

您需要注意:

  • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。

  • 如果NetworkInterface.N.InstanceType取值为Primary,则无需设置该参数。

Network_Name
Descriptionstring

弹性网卡的描述。

您需要注意:

  • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。
  • 长度为 2~256 个英文或中文字符,不能以http://https://开头。
  • 如果NetworkInterface.N.InstanceType取值为Primary,则无需设置该参数。
Network_Description
SecurityGroupIdstring

弹性网卡所属的安全组 ID。

您需要注意:

  • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。

  • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数。此时该参数的作用等同于SecurityGroupId,但需要注意不能再设置SecurityGroupIdSecurityGroupIds.NNetworkInterface.N.SecurityGroupIds.N

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的安全组。

sg-bp67acfmxazb4p****
PrimaryIpAddressstring

添加一张弹性网卡并设置主 IP 地址。

您需要注意:

  • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。

    • 设置 1 个弹性网卡时,支持设置 1 个主网卡或 1 个辅助网卡。如果Amount参数取值大于 1,且设置了主网卡并设置了该参数,则表示在批量创建 ECS 实例时,以指定的主 IP 地址为起始地址,依次为多台 ECS 实例分配连续的主 IP 地址,但需要注意,此时不支持再为实例绑定辅助网卡。
    • 需要注意,如果Amount参数取值大于 1 且已为主网卡设置了该参数,则不支持再设置辅助网卡(即不支持再设置NetworkInterface.2.InstanceType=Secondary)。
  • 如果NetworkInterface.N.InstanceType取值为Primary,则该参数的作用等同于PrivateIpAddress,但需要注意不能同时设置PrivateIpAddress参数。

  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,表示为辅助网卡设置主 IP 地址。默认从网卡所属的交换机网段中随机选择一个 IP 地址。

说明
  • 每个交换机的第 1 个和最后 3 个 IP 地址为系统保留地址,不支持指定。 例如,交换机的网段为 192.168.1.0/24,则 192.168.1.0、192.168.1.253、192.168.1.254 和 192.168.1.255 这 4 个地址是系统保留地址。
  • 172.16.**.**
    QueueNumberinteger

    弹性网卡队列数。

    您需要注意:

    • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。

    • 不能超过实例规格允许的单块网卡最大队列数。

    • 实例的所有网卡累加队列数不能超过实例规格允许的队列数总配额。实例规格的单块网卡最大队列数和总配额可以通过 DescribeInstanceTypes 接口查询MaximumQueueNumberPerEniTotalEniQueueQuantity字段。

    • 如果NetworkInterface.N.InstanceType取值为Primary,且设置了该参数取值,则不能再设置NetworkInterfaceQueueNumber参数。

    8
    SecurityGroupIdsarray

    弹性网卡所属的一个或多个安全组 ID。

    • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。
    • 第二个 N 表示可以指定一个或多个安全组 ID。N 的取值范围与实例能够加入安全组配额有关。更多信息,请参见安全组限制

    您需要注意:

    • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数或NetworkInterface.N.SecurityGroupId。此时该参数的作用等同于SecurityGroupIds.N,但需要注意不能再设置SecurityGroupIdSecurityGroupIds.NNetworkInterface.N.SecurityGroupId

    • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的安全组。

    string

    弹性网卡所属的一个或多个安全组 ID。

    • N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。
    • 第二个 N 表示可以指定一个或多个安全组 ID。N 的取值范围与实例能够加入安全组配额有关。更多信息,请参见安全组限制

    您需要注意:

    • 如果NetworkInterface.N.InstanceType取值为Primary,则必须设置该参数或NetworkInterface.N.SecurityGroupId。此时该参数的作用等同于SecurityGroupIds.N,但需要注意不能再设置SecurityGroupIdSecurityGroupIds.NNetworkInterface.N.SecurityGroupId

    • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为 ECS 实例所属的安全组。

    sg-bp15ed6xe1yxeycg7****
    NetworkInterfaceTrafficModestring

    网卡的通讯模式。参数取值范围:

    • Standard:使用 TCP 通讯模式。
    • HighPerformance:开启 ERI(Elastic RDMA Interface)接口,使用 RDMA 通讯模式。

    默认值:Standard。

    说明 RDMA 模式的弹性网卡数量不能超过该实例规格族的限制。更多信息,请参见实例规格族
    Standard
    QueuePairNumberlong

    RDMA 网卡队列数。

    0
    InstanceTypestring

    弹性网卡类型。N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes  查看目标实例规格支持的网卡数。

    参数取值范围:

    • Primary:主网卡。
    • Secondary:辅助网卡。

    默认值:Secondary。

    Secondary
    Ipv6AddressCountlong

    为主网卡指定随机生成的 IPv6 地址数量。取值范围:1~10

    您需要注意:

    • NetworkInterface.N.InstanceType取值为Primary时,设置该参数才会生效。如果NetworkInterface.N.InstanceType取值为Secondary或空值,则不能设置该参数。

    • 设置该参数后,您不能再设置Ipv6AddressCountIpv6Address.NNetworkInterface.N.Ipv6Address.N

    1
    Ipv6Addressarray

    为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即第二个 N 的取值范围:1~10。

    取值示例:Ipv6Address.1=2001:db8:1234:1a00::***

    您需要注意:

    • NetworkInterface.N.InstanceType取值为Primary时,设置该参数才会生效。如果NetworkInterface.N.InstanceType取值为Secondary或空值,则不能设置该参数。

    • 设置该参数后,Amount取值只能为 1,且不能再设置Ipv6AddressCountIpv6Address.NNetworkInterface.N.Ipv6AddressCount

    string

    为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即第二个 N 的取值范围:1~10

    取值示例:Ipv6Address.1=2001:db8:1234:1a00::***

    您需要注意:

    • NetworkInterface.N.InstanceType取值为Primary时,设置该参数才会生效。如果NetworkInterface.N.InstanceType取值为Secondary或空值,则不能设置该参数。

    • 设置该参数后,Amount取值只能为 1,且不能再设置Ipv6AddressCountIpv6Address.NNetworkInterface.N.Ipv6AddressCount

    2001:db8:1234:1a00::***
    NetworkCardIndexinteger

    网卡指定的物理网卡索引。

    您需要注意:

    • 只有特定实例规格支持指定物理网卡索引。
    • NetworkInterface.N.InstanceType 取值为 Primary 时,对于支持物理网卡的实例规格,如果设置此参数,只能设置为 0。
    • NetworkInterface.N.InstanceType 取值为 Secondary 或者空值,对于支持物理网卡的实例规格,此参数可以依据实例规格设置。更多信息,请参见实例规格族
    0
    DeleteOnReleaseboolean

    释放实例时是否保留网卡。取值范围:

    • true:不保留。

    • false:保留。

    默认值:true。

    说明 该参数只对辅助网卡生效。
    true
    NetworkInterfaceIdstring

    随实例附加的弹性网卡 ID。

    说明 该参数只对辅助弹性网卡生效。指定一个现有辅助弹性网卡后,您将无法配置其它网卡创建参数。
    eni-bp1gn106np8jhxhj****
    RxQueueSizeinteger

    弹性网卡入方向队列深度。

    您需要注意:

    • 网卡的入方向队列深度必须和出方向队列深度相等,取值范围:8192~16384,且必须为 2 的幂。

    • 较大的入方向队列深度可以提升入方向的吞吐量,但会占用更多的内存。

    8192
    TxQueueSizeinteger

    弹性网卡出方向队列深度。

    您需要注意:

    • 网卡的出方向队列深度必须和入方向队列深度相等,取值范围:8192~16384,且必须为 2 的幂。

    • 较大的出方向队列深度可以提升出方向的吞吐量,但会占用更多的内存。

    8192
    Tagarray<object>

    实例、云盘和主网卡的标签信息。

    object

    实例、云盘和主网卡的标签信息。

    Keystring

    实例、云盘和主网卡的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或 https://。

    TestKey
    Valuestring

    实例、云盘和主网卡的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。

    TestValue
    Ipv6Addressarray

    为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即 N 的取值范围:1~10。

    取值示例:Ipv6Address.1=2001:db8:1234:1a00::***

    您需要注意:

    • 设置了Ipv6Address.N时,Amount参数取值只能为 1,且不能同时设置Ipv6AddressCount

    • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置Ipv6Addresses.NIpv6AddressCount,而是需要设置NetworkInterface.N.Ipv6Addresses.NNetworkInterface.N.Ipv6AddressCount

    string

    为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即 N 的取值范围:1~10。

    取值示例:Ipv6Address.1=2001:db8:1234:1a00::***

    您需要注意:

    • 设置了Ipv6Address.N时,Amount参数取值只能为 1,且不能同时设置Ipv6AddressCount

    • 如果NetworkInterface.N.InstanceType取值为Primary,则不能设置Ipv6Addresses.NIpv6AddressCount,而是需要设置NetworkInterface.N.Ipv6Addresses.NNetworkInterface.N.Ipv6AddressCount

    2001:db8:1234:1a00::***
    SystemDiskobject

    系统盘相关参数,目前专属块存储集群 ID(StorageClusterId)需要通过该参数设置参数值。

    StorageClusterIdstring

    专属块存储集群 ID。如果您在创建 ECS 实例时,需要使用专属块存储集群中的云盘资源作为系统盘,请设置该参数。

    dbsc-j5e1sf2vaf5he8m2****
    ProvisionedIopslong

    ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。

    基准性能=min{1,800+50*容量, 50,000}。

    说明 SystemDisk.Category取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘
    40000
    BurstingEnabledboolean

    是否开启 Burst(性能突发)。取值范围:

    • true:是。
    • false:否。
    说明 SystemDisk.Category取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘
    false
    Encryptedstring

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

    • true:加密。

    • false:不加密。

    默认值:false。

    说明 中国(香港)D 可用区、新加坡 A 可用区暂不支持在创建实例时加密系统盘。
    false
    KMSKeyIdstring

    系统盘对应的 KMS 密钥 ID。

    0e478b7a-4262-4802-b8cb-00d3fb40****
    EncryptAlgorithmstring
    说明 该参数暂未开放使用。
    null
    ImageOptionsobject

    镜像相关属性信息。

    LoginAsNonRootboolean

    使用该镜像的实例是否支持使用 ecs-user 用户登录。可能值:

    • true:是

    • false:否

    false
    NetworkOptionsobject

    网络相关属性参数。

    EnableJumboFrameboolean

    实例是否开启 Jumbo frame 特性。参数取值范围:

    • false:不开启 Jumbo frame, 该实例下的所有网卡(包括主网卡及辅助网卡)MTU 取值为 1500。

    • true:开启 Jumbo frame, 该实例下的所有网卡(包括主网卡及辅助网卡)的 MTU 取值为 8500。

    默认值:true。

    说明 只有八代以上部分实例规格支持开启 Jumbo frame 特性。更多信息请参见ECS 实例 MTU
    false
    AutoPayboolean

    创建实例时,是否自动支付。取值范围:

    • true:自动支付。

      说明 自动支付时,请确保支付方式余额充足,否则会生成异常订单,只能作废订单。如果您的支付方式余额不足,可以将参数AutoPay置为false,此时会生成未支付订单,您可以登录 ECS 管理控制台自行支付。
    • false:只生成订单不扣费。

      说明 InstanceChargeType 取值为PostPaid时,AutoPay不能设置为false

    默认值:true。

    true
    PrivateDnsNameOptionsobject
    说明 该参数正在邀测中,暂不开放使用。
    EnableInstanceIdDnsARecordboolean
    说明 该参数正在邀测中,暂不开放使用。
    false
    EnableInstanceIdDnsAAAARecordboolean
    说明 该参数正在邀测中,暂不开放使用。
    true
    EnableIpDnsARecordboolean
    说明 该参数正在邀测中,暂不开放使用。
    true
    EnableIpDnsPtrRecordboolean
    说明 该参数正在邀测中,暂不开放使用。
    false
    HostnameTypestring
    说明 该参数正在邀测中,暂不开放使用。
    Custom

    返回参数

    名称类型描述示例值
    object

    创建实例返回信息集合。

    RequestIdstring

    请求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    OrderIdstring

    订单 ID。该参数只有创建包年包月 ECS 实例(请求参数InstanceChargeType=PrePaid)时有返回值。

    123456****
    TradePricefloat

    订单成交价。

    0.165
    InstanceIdSetsarray

    实例 ID(InstanceIdSet)列表。

    string

    实例 ID(InstanceIdSet)列表。

    ["i-bp67acfmxazb4pd2****", "i-bp1i43l28m7u48p1****", "i-bp12yqg7jdyxl11f****"]

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
      "OrderId": "123456****",
      "TradePrice": 0.165,
      "InstanceIdSets": {
        "InstanceIdSet": [
          "[\"i-bp67acfmxazb4pd2****\", \"i-bp1i43l28m7u48p1****\", \"i-bp12yqg7jdyxl11f****\"]"
        ]
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    400LoginAsNonRoot.ImageNotSupportThe specified image does not support login as non-root.此镜像不支持NonRoot登录。
    400InvalidParam.NotSupportJumboFrameNot support jumbo frame.-
    400InsufficientBalance.AgentCreditInsufficient agent credit. Please contact your agent.代理商信用不足,请与您的代理商联系。
    400QuotaExceed.DiskCapacityThe used capacity of disk type has exceeded the quota in the zone, %s.指定磁盘类型的已用容量超出可用区配额限制,您可以前往配额中心查询和申请提升磁盘容量配额。
    400InvalidPeriod.ExceededDedicatedHostInstance expired date can not exceed dedicated host expired date.实例过期日期不能超过专有宿主机的过期日期。
    400InvalidParam.SecondaryNetworkInterfaceWhen min amount greater than 1 and the PrivateIpAddress or Primary NetworkInterface is specified,the Secondary NetworkInterface IP parameter cannot be specified.-
    400InvalidPrimaryIpAddress.SizeInvalidThe NetworkInterface PrimaryIpAddress is used to create only one instance.-
    400InvalidStorageClusterId.CapacityNotEnoughThe remaining capacity of the current dedicated storage cluster is less than the size of disk.磁盘所在专属存储集群的可用容量不足
    400InvalidStorageClusterId.StatusNotSupportThe current status of the dedicated storage cluster cannot create a cloud disk yet.-
    400InvalidStorageClusterId.ZoneIdEmptyThe specified param ZoneId cannot be empty when StorageClusterId given.-
    400InvalidStorageClusterId.PerformanceLevelNotMatchThe current dedicated storage cluster cannot create this performance level of disk.-
    400InvalidStorageClusterId.CategoryNotMatchThe current dedicated storage cluster cannot create this category of disk.-
    400InvalidStorageClusterId.DiskSizeEmptyThe specified param DiskSize cannot be empty when StorageClusterId given.-
    400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.指定的实例规格未授权使用。
    400InvalidInstanceType.ValueNotSupportedThe specified InstanceType beyond the permitted range.指定的实例规格不合法(超出可选范围)。
    400InvalidDescription.MalformedThe specified parameter "Description" is not valid.指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。
    400InvalidInternetChargeType.ValueNotSupportedThe specified InternetChargeType is not valid.暂不支持指定的网络付费类型的实例,请确认相关参数是否正确。
    400InvalidParameterThe specified parameter "InternetMaxBandwidthOut" is not valid.-
    400InvalidHostName.MalformedThe specified parameter "HostName" is not valid.-
    400InvalidPassword.MalformedThe specified parameter "Password" is not valid.-
    400InvalidPasswordParam.MismatchThe input password should be null when passwdInherit is true.启用 PasswdInherit 后,用户名密码应该设置为空。
    400InvalidSystemDiskCategory.ValueNotSupportedThe specified parameter "SystemDisk.Category" is not valid.-
    400InvalidDiskName.MalformedThe specified parameter "SyatemDisk.DiskName or DataDisk.n.DiskName" is not valid.-
    400InvalidDiskDescription.MalformedThe specified parameter "SyatemDisk.DiskDescription" or "DataDisk.n.Description" is not valid.-
    400InvalidDataDiskSize.ValueNotSupportedThe specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.指定的 DataDisk.n.Size 超出允许范围,或者快照的容量超过指定磁盘类别的大小限制。
    400InvalidDataDiskCategory.ValueNotSupportedThe specified parameter "DataDisk.n.Category" is not valid.-
    400InvalidDataDevice.MalformedThe specified parameter "DataDisk.n.Device" is not valid.-
    400InvalidNodeControllerId.MalformedThe specified parameter "NodeControllerId" is not valid.-
    400InvalidInnerIpAddress.MalformedThe specified parameter "InnerIpAddress" is not valid.-
    400InvalidInnerIpAddress.UnusableThe specified InnerIpAddress is already used or not found in usable ip range.指定的 InnerIpAddress 不可用。
    400InvalidParameter.ConflictThe specified image does not support the specified instance type.指定的镜像不能用于指定的实例规格。
    400ImageNotSupportCloudInitThe specified image does not support cloud-init.该镜像不支持CloudInit。