调用RunInstances接口,并可以指定ImageId、InstanceType、SecurityGroupId、VSwitchId等参数,创建一台或多台按量付费或者包年包月ECS实例。
接口说明
-
准备工作:
- 通过实名认证。更多信息,请参见账号实名认证相关文档。
- 成本估算:了解云服务器 ECS 的计费方式。更多信息,请参见计费概述。
- 产品选型:调用 DescribeInstanceTypes 查看目标实例规格的性能数据,或者参见选型配置了解如何选择实例规格。
- 查询库存:调用 DescribeAvailableResource 查看指定地域或者可用区内的资源供给情况。
- 网络规划:您需要确保您已经有可用的安全组。更多信息,请参见 CreateSecurityGroup 。创建专有网络 VPC 类型实例前,您需要预先在相应的阿里云地域创建 VPC。
-
与 CreateInstance 对比差异:
和 CreateInstance 接口相比,RunInstances 接口有以下优点:
- 单次最多可以创建 100 台实例,避免重复多次调用 CreateInstance。
- 实例创建之后,实例会自动变成
Starting
状态,然后变成Running
状态,不需要再调用 StartInstance 启动实例。 - 创建实例时可以指定
InternetMaxBandwidthOut
为 ECS 实例分配公网 IP,不需要您再调用 AllocatePublicIpAddress 分配公网 IP。 - 您可以指定
AutoReleaseTime
参数来设定自动释放时间,不需要再调用 ModifyInstanceAutoReleaseTime 设置自动释放时间。 - 您可以指定
LaunchTemplateId
和LaunchTemplateVersion
使用启动模板,可以免除您每次创建实例时都需要填入大量配置参数。 - 可以指定
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 支持以下任一方式绑定主网卡,但需要注意一次调用只能选用一种方式配置主网卡,同时使用两种方式将会调用失败并返回错误信息。
- 通过
SecurityGroupId
、VSwitchId
、PrivateIpAddress
、NetworkInterfaceQueueNumber
与Ipv6AddressCount
等参数直接设置主网卡的相关配置信息。 - 通过
NetworkInterface.N.*
设置主网卡以及辅助网卡的配置信息。当NetworkInterface.N.InstanceType
取值为Primary
时,表示设置主网卡;当NetworkInterface.N.InstanceType
取值为Secondary
或空值时,表示设置辅助网卡。
- 通过
-
提交创建任务后,参数不合法或者库存不足的情况下会报错,具体的报错原因参见错误码。
-
-
最佳实践:
-
单次大批量创建 ECS 实例(大于 100 台)遇到库存不足的场景;对实例规格或可用区等资源配置无指定要求,更关注如何快速创建实例的场景;对 ECS 实例数量无指定要求,更关注总算力 vCPU 个数等场景下,阿里云推荐您使用弹性供应组。您可以通过 CreateAutoProvisioningGroup 创建弹性供应组,一键式地部署跨计费方式、跨可用区、跨实例规格族的实例集群。更多信息,请参见使用弹性供应组 API 批量创建 ECS 实例。
-
RunInstances
可以执行批量创建任务,为便于管理与检索,建议您为每批次启动的实例指定标签(Tag.N.Key
和Tag.N.Value
),并且为主机名(HostName
)和实例名称(InstanceName
)添加有序后缀(UniqueSuffix
)。 -
实例启动模板能免除您每次创建实例时都需要填入大量配置参数,您可以创建实例启动模板( CreateLaunchTemplate )后,在
RunInstances
请求中指定LaunchTemplateId
和LaunchTemplateVersion
使用启动模板。
-
示例 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:RunInstances | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ImageId | string | 否 | 镜像 ID,启动实例时选择的镜像资源。您可以通过 DescribeImages 查询您可以使用的镜像资源。如果您不指定 | aliyun_2_1903_x64_20G_alibase_20200324.vhd |
ImageFamily | string | 否 | 镜像族系名称,通过设置该参数来获取当前镜像族系内最新可用镜像来创建实例。 镜像族系的名称长度为 2~128 个字符。镜像族系名称不能以特殊字符、数字、http://、https://开头,只可包含特殊字符中的"."、"_"、"-"和":"。 您需要注意:
说明
阿里云官方镜像关联的镜像族系信息请参见公共镜像概述。
| hangzhou-daily-update |
InstanceType | string | 否 | 实例的资源规格。如果您不指定
| ecs.g6.large |
SecurityGroupId | string | 否 | 新创建实例所属于的安全组 ID。同一个安全组内的实例之间可以互相访问,一个安全组能容纳的实例数量视安全组类型而定,具体请参见使用限制的安全组章节。 说明
SecurityGroupId 决定了实例的网络类型,例如,如果设置的安全组的网络类型为专有网络 VPC,实例则为 VPC 类型,并同时需要指定参数VSwitchId 。
如果您不设置
| sg-bp15ed6xe1yxeycg7**** |
VSwitchId | string | 否 | 虚拟交换机 ID。如果您创建的是 VPC 类型 ECS 实例,必须指定虚拟交换机 ID,且安全组和虚拟交换机在同一个专有网络 VPC 中。您可以调用 DescribeVSwitches 查询已创建的交换机的相关信息。 您需要注意:
| vsw-bp1s5fnvk4gn2tws0**** |
InstanceName | string | 否 | 实例名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。默认值为实例的 创建多台 ECS 实例时,您可以批量设置有序的实例名称,并且可以包含方括号([])和逗号(,)。具体操作,请参见批量设置有序的实例名称或主机名称。 | k8s-node-[1,4]-alibabacloud |
Description | string | 否 | 实例的描述。长度为 2~256 个英文或中文字符,不能以 | Instance_Description |
InternetMaxBandwidthIn | integer | 否 | 公网入带宽最大值,单位为 Mbit/s。取值范围:
| 10 |
InternetMaxBandwidthOut | integer | 否 | 公网出带宽最大值,单位为 Mbit/s。取值范围:0~100。 默认值:0。 | 10 |
HostName | string | 否 | 实例主机名称。限制说明如下:
创建多台 ECS 实例时,您可以:
| k8s-node-[1,4]-ecshost |
UniqueSuffix | boolean | 否 | 当创建多台实例时,是否为
默认值:false。 当 更多信息,请参见批量设置有序的实例名称或主机名称。 | true |
Password | string | 否 | 实例的密码。长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是:
其中,Windows 实例不能以正斜线(/)为密码首字符。 说明
如果传入 Password 参数,建议您使用 HTTPS 协议发送请求,避免密码泄露。
| EcsV587! |
PasswordInherit | boolean | 否 | 是否使用镜像预设的密码。取值范围:
默认值:false。 说明
使用该参数时,Password 参数必须为空,同时您需要确保使用的镜像已经设置了密码。
| false |
ZoneId | string | 否 | 实例所属的可用区 ID,您可以调用 DescribeZones 获取可用区列表。 说明
如果您指定了 VSwitchId 参数,则指定的ZoneId 参数必须和交换机所在的可用区保持一致。您也可以不指定ZoneId 参数,系统将自动选择指定的交换机所在的可用区。
默认值:系统自动选择。 | cn-hangzhou-g |
InternetChargeType | string | 否 | 网络计费类型。取值范围:
默认值:PayByTraffic。 说明
按使用流量计费模式下的出入带宽峰值都是带宽上限,不作为业务承诺指标。当出现资源争抢时,带宽峰值可能会受到限制。如果您的业务需要有带宽的保障,请使用按固定带宽计费模式。
| PayByTraffic |
SystemDisk.Size | string | 否 | 系统盘大小,单位为 GiB。取值范围:
该参数的取值必须大于或者等于 max{1, ImageSize}。 默认值:max{40, 参数 ImageId 对应的镜像大小}。 | 40 |
SystemDisk.Category | string | 否 | 系统盘的云盘种类。取值范围:
说明
仅当 InstanceType 设置为通用算力型实例规格族 u1(ecs.u1 )或经济型实例规格族 e(ecs.e )时,该参数支持取cloud_essd_entry 值。
已停售的实例规格且非 I/O 优化实例默认值为 cloud,否则默认值为 cloud_efficiency。 | cloud_ssd |
SystemDisk.DiskName | string | 否 | 系统盘名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。 | cloud_ssdSystem |
SystemDisk.Description | string | 否 | 系统盘的描述。长度为 2~256 个英文或中文字符,不能以 | SystemDisk_Description |
SystemDisk.PerformanceLevel | string | 否 | 创建 ESSD 云盘作为系统盘使用时,设置云盘的性能等级。取值范围:
有关如何选择 ESSD 性能等级,请参见 ESSD 云盘。 | PL0 |
SystemDisk.AutoSnapshotPolicyId | string | 否 | 系统盘采用的自动快照策略 ID。 | sp-bp67acfmxazb4p**** |
IoOptimized | string | 否 | 是否为 I/O 优化实例。已停售的实例规格实例默认值是 none,其他实例规格默认值是 optimized。取值范围:
| optimized |
UserData | string | 否 | 实例自定义数据。必须填写已采用 Base64 编码后的数据,且在进行 Base64 编码前自定义数据内容的大小不能超过 32 KB。 有关实例自定义数据的使用限制、格式以及运行频率的详细信息,请参见实例自定义数据。 说明
为保证传输过程中 UserData 的安全性,请避免直接以明文形式传送敏感数据,如密码和私钥。若需传送此类信息,建议先行加密处理,并采用 Base64 编码方式,随后在实例内部进行解密以确保信息安全。
| ZWNobyBoZWxsbyBlY3Mh |
KeyPairName | string | 否 | 密钥对名称。 说明
Windows 实例,忽略该参数。默认为空。即使填写了该参数,仍旧只执行 Password 的内容。
| KeyPair_Name |
RamRoleName | string | 否 | 实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。 | RAM_Name |
Amount | integer | 否 | 指定创建 ECS 实例的数量。取值范围:1~100。 创建成功的 ECS 数量与指定的 Amount 和 minAmount 数量有关:
默认值:1。 | 3 |
MinAmount | integer | 否 | 指定 ECS 实例最小购买数量。取值范围:1~100。 创建成功的 ECS 数量与指定的 Amount 和 minAmount 数量有关:
| 2 |
AutoReleaseTime | string | 否 | 按量付费实例的自动释放时间。按照ISO 8601标准表示,使用 UTC+0 时间。格式为:
| 2018-01-01T12:05:00Z |
SpotStrategy | string | 否 | 按量付费实例的竞价策略。当参数
默认值:NoSpot。 | NoSpot |
SpotDuration | integer | 否 | 抢占式实例的保留时长,单位为小时。 默认值:1。取值范围:
实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。 | 1 |
SpotPriceLimit | float | 否 | 设置实例的每小时最高价格。支持最大 3 位小数,参数 | 0.97 |
SpotInterruptionBehavior | string | 否 | Terminate | |
SecurityEnhancementStrategy | string | 否 | 是否开启安全加固。取值范围:
| Active |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
HpcClusterId | string | 否 | 实例所属的 HPC 集群 ID。 创建 SCC 实例时,该参数为必选参数。您可以参考 CreateHpcCluster 创建 HPC 集群。 | hpc-bp67acfmxazb4p**** |
DryRun | boolean | 否 | 是否只预检此次请求。取值范围:
| false |
DedicatedHostId | string | 否 | 是否在专有宿主机上创建 ECS 实例。由于专有宿主机不支持创建抢占式实例,指定 您可以通过 DescribeDedicatedHosts 查询专有宿主机 ID 列表。 | dh-bp67acfmxazb4p**** |
LaunchTemplateId | string | 否 | 启动模板 ID。更多信息,请调用 DescribeLaunchTemplates 。 使用启动模板创建实例时,您必须指定 | lt-bp1apo0bbbkuy0rj**** |
LaunchTemplateName | string | 否 | 启动模板名称。 使用启动模板创建实例时,您必须指定 | LaunchTemplate_Name |
LaunchTemplateVersion | long | 否 | 启动模板版本。如果您指定了 | 3 |
ResourceGroupId | string | 否 | 实例所在的企业资源组 ID。 | rg-bp67acfmxazb4p**** |
Period | integer | 否 | 购买资源的时长,单位由
| 1 |
PeriodUnit | string | 否 | 包年包月计费方式的时长单位。取值范围:
| Month |
AutoRenew | boolean | 否 | 是否要自动续费。当参数
默认值:false。 | true |
AutoRenewPeriod | integer | 否 | 单次自动续费的续费时长。取值范围:
默认值:1。 | 1 |
InstanceChargeType | string | 否 | 实例的付费方式。取值范围:
默认值:PostPaid。 选择包年包月时,您必须确认自己的账号支持余额支付或者信用支付,否则将返回 | PrePaid |
DeploymentSetId | string | 否 | 部署集 ID。 | ds-bp1brhwhoqinyjd6**** |
DeploymentSetGroupNo | integer | 否 | 如果您设置的部署集对应的策略为部署集组高可用策略(AvailabilityGroup),可以通过该参数指定实例在部署集中的分组号。取值范围:1~7。 | 1 |
PrivateIpAddress | string | 否 | 实例私网 IP 地址。专有网络 VPC 类型 ECS 实例设置私网 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 个地址是系统保留地址。
| 10.1.**.** |
CreditSpecification | string | 否 | Standard | |
Ipv6AddressCount | integer | 否 | 为主网卡指定随机生成的 IPv6 地址数量。取值范围:1~10。 您需要注意:
| 1 |
NetworkInterfaceQueueNumber | integer | 否 | 主网卡队列数。您需要注意:
| 8 |
DeletionProtection | boolean | 否 | 实例释放保护属性,指定是否支持通过控制台或 API( DeleteInstance )释放实例。取值范围:
默认值:false。 说明
该属性仅适用于按量付费实例,且只能限制手动释放操作,对系统释放操作不生效。
| false |
HibernationOptions.Configured | boolean | 否 | 说明
该参数正在邀测中,暂未开放使用。
| false |
Affinity | string | 否 | 专有宿主机实例是否与专有宿主机关联。取值范围:
默认值:default。 | default |
Tenancy | string | 否 | 是否在专有宿主机上创建实例。取值范围:
默认值:default。 | default |
StorageSetId | string | 否 | 存储集 ID。 | ss-bp67acfmxazb4p**** |
StorageSetPartitionNumber | integer | 否 | 存储集中的最大分区数量。取值范围:大于等于 2。 | 2 |
CpuOptions.Core | integer | 否 | CPU 核心数。该参数不支持自定义设置,只能采用默认值。 默认值:请参见自定义 CPU 选项。 | 2 |
CpuOptions.ThreadsPerCore | integer | 否 | CPU 线程数。ECS 实例的 vCPU 数=
取值范围和默认值:请参见自定义 CPU 选项。 | 2 |
CpuOptions.Numa | string | 否 | 该参数已弃用。 | 1 |
CpuOptions.TopologyType | string | 否 | 实例的 Cpu 拓扑类型。取值范围:
默认值:无。 说明
仅部分实例规格族支持使用本参数,具体支持实例规格族请参见查看和修改 CPU 拓扑结构。
| DiscreteCoreToHTMapping |
SecurityOptions.TrustedSystemMode | string | 否 | 可信系统模式。取值:vTPM。 目前,可信系统模式支持的实例规格族:
当您创建以上实例规格族的 ECS 实例时,需要设置该参数。具体说明如下:
说明
如果您在创建实例的时候指定其为可信实例,那么当您更换系统盘时只能使用支持可信系统的镜像。
关于可信系统的更多信息,请参见安全增强型实例可信功能概述。 | vTPM |
SecurityOptions.ConfidentialComputingMode | string | 否 | 机密计算模式。取值:Enclave。 该参数取值为 Enclave 时,表示 ECS 实例使用 Enclave 构建机密计算环境。目前仅实例规格族 c7、g7、r7,支持调用
关于机密计算的更多信息,请参见使用 Enclave 构建机密计算环境。 | Enclave |
HttpEndpoint | string | 否 | enabled | |
HttpTokens | string | 否 | 访问实例元数据时是否强制使用加固模式(IMDSv2)。取值范围:
默认值:optional。 说明
有关访问实例元数据的模式,请参见实例元数据访问模式。
| optional |
HttpPutResponseHopLimit | integer | 否 | 实例元数据请求所需的 HTTP PUT 响应跃点限制。取值范围:1~64。 默认值:1。 | 3 |
PrivatePoolOptions.MatchCriteria | string | 否 | 实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值范围:
默认值:None。 以下任一场景,实例启动的私有池容量选项只能取值
| Open |
PrivatePoolOptions.Id | string | 否 | 私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。 | eap-bp67acfmxazb4**** |
Isp | string | 否 | 说明
该参数正在邀测中,暂未开放使用。
| null |
SchedulerOptions.DedicatedHostClusterId | string | 否 | 指定 ECS 实例所属的专有宿主机集群,系统会自动选择该专有宿主机集群中的一台专有宿主机部署 ECS 实例。 说明
仅在 Tenancy 设置为host 时生效。
在您同时指定了专有宿主机(
您可以通过 DescribeDedicatedHostClusters 查询专有宿主机集群 ID 列表。 | dc-bp12wlf6am0vz9v2**** |
SecurityGroupIds | array | 否 | 将实例同时加入多个安全组。N 的取值范围与实例能够加入安全组配额有关。更多信息,请参见安全组限制。 您需要注意:
| |
string | 否 | 将实例同时加入多个安全组。N 的取值范围与实例能够加入安全组配额有关。更多信息,请参见安全组限制。 您需要注意:
| sg-bp15ed6xe1yxeycg7**** | |
HostNames | array | 否 | 创建多台实例时,为每台实例指定不同的主机名。 | |
string | 否 | 创建多台实例时,为每台实例指定不同的主机名。限制说明如下:
| ecs-host-01 | |
DataDisk | array<object> | 否 | 数据盘信息集合列表。 | |
object | 否 | 数据盘信息集合。 | ||
PerformanceLevel | string | 否 | 创建 ESSD 云盘作为数据盘使用时,设置云盘的性能等级。N 的取值必须和
有关如何选择 ESSD 性能等级,请参见 ESSD 云盘。 | PL1 |
AutoSnapshotPolicyId | string | 否 | 数据盘采用的自动快照策略 ID。 | sp-bp67acfmxazb4p**** |
Encrypted | string | 否 | 数据盘 N 是否加密。取值范围:
默认值:false。 | false |
Description | string | 否 | 数据盘的描述。长度为 2~256 个英文或中文字符,不能以 | DataDisk_Description |
SnapshotId | string | 否 | 创建数据盘 N 使用的快照。N 的取值范围为 1~16。 指定参数 | s-bp17441ohwka0yuh**** |
Device | string | 否 | 数据盘的挂载点。挂载的数据盘数量不同,挂载点的命名不同:
说明
该参数仅用于全镜像(整机镜像)场景。您可以通过将此参数设置为全镜像中数据盘对应的挂载点,并修改对应的 DataDisk.N.Size 和DataDisk.N.Category 参数,达到修改全镜像中数据盘磁盘种类和大小的目的。
| /dev/xvdb |
Size | integer | 否 | 第 n 个数据盘的容量大小,N 的取值范围为 1~16,内存单位为 GiB。取值范围:
说明
该参数的取值必须大于等于参数 SnapshotId 指定的快照的大小。
| 2000 |
DiskName | string | 否 | 数据盘名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。 | cloud_ssdData |
Category | string | 否 | 数据盘 N 的云盘种类。取值范围:
对于 I/O 优化实例,默认值为 cloud_efficiency。对于非 I/O 优化实例,默认值为 cloud。 | cloud_ssd |
EncryptAlgorithm | string | 否 | 说明
该参数暂未开放使用。
| null |
DeleteWithInstance | boolean | 否 | 表示数据盘是否随实例释放。取值范围:
默认值为 true。 | true |
KMSKeyId | string | 否 | 数据盘对应的 KMS 密钥 ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
StorageClusterId | string | 否 | 专属块存储集群 ID。如果您在创建 ECS 实例时,需要使用专属块存储集群中的云盘资源作为数据盘,请设置该参数。 | dbsc-j5e1sf2vaf5he8m2**** |
ProvisionedIops | long | 否 | ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50000}。 说明
当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘。
| 40000 |
BurstingEnabled | boolean | 否 | 是否开启 Burst(性能突发)。取值范围:
说明
当 DiskCategory 取值为 cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘。
| false |
Arn | array<object> | 否 | 说明
该参数暂未开放使用。
| |
object | 否 | 说明
该参数暂未开放使用。
| ||
RoleType | string | 否 | 说明
该参数暂未开放使用。
| null |
Rolearn | string | 否 | 说明
该参数暂未开放使用。
| null |
AssumeRoleFor | long | 否 | 说明
该参数暂未开放使用。
| null |
NetworkInterface | array<object> | 否 | 弹性网卡信息。 | |
object | 否 | 弹性网卡信息。 | ||
VSwitchId | string | 否 | 弹性网卡所属的虚拟交换机 ID。 您需要注意:
| vsw-bp67acfmxazb4p**** |
NetworkInterfaceName | string | 否 | 弹性网卡名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。 您需要注意:
| Network_Name |
Description | string | 否 | 弹性网卡的描述。 您需要注意:
| Network_Description |
SecurityGroupId | string | 否 | 弹性网卡所属的安全组 ID。 您需要注意:
| sg-bp67acfmxazb4p**** |
PrimaryIpAddress | string | 否 | 添加一张弹性网卡并设置主 IP 地址。 您需要注意:
说明
| 172.16.**.** |
QueueNumber | integer | 否 | 弹性网卡队列数。 您需要注意:
| 8 |
SecurityGroupIds | array | 否 | 弹性网卡所属的一个或多个安全组 ID。
您需要注意:
| |
string | 否 | 弹性网卡所属的一个或多个安全组 ID。
您需要注意:
| sg-bp15ed6xe1yxeycg7**** | |
NetworkInterfaceTrafficMode | string | 否 | 网卡的通讯模式。参数取值范围:
默认值:Standard。 说明
RDMA 模式的弹性网卡数量不能超过该实例规格族的限制。更多信息,请参见实例规格族。
| Standard |
QueuePairNumber | long | 否 | RDMA 网卡队列数。 | 0 |
InstanceType | string | 否 | 弹性网卡类型。N 的取值范围不超过实例规格支持网卡数。请参见实例规格族或调用 DescribeInstanceTypes 查看目标实例规格支持的网卡数。 参数取值范围:
默认值:Secondary。 | Secondary |
Ipv6AddressCount | long | 否 | 为主网卡指定随机生成的 IPv6 地址数量。取值范围:1~10 您需要注意:
| 1 |
Ipv6Address | array | 否 | 为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即第二个 N 的取值范围:1~10。 取值示例: 您需要注意:
| |
string | 否 | 为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即第二个 N 的取值范围:1~10 取值示例: 您需要注意:
| 2001:db8:1234:1a00::*** | |
NetworkCardIndex | integer | 否 | 网卡指定的物理网卡索引。 您需要注意:
| 0 |
DeleteOnRelease | boolean | 否 | 释放实例时是否保留网卡。取值范围:
默认值:true。 说明
该参数只对辅助网卡生效。
| true |
NetworkInterfaceId | string | 否 | 随实例附加的弹性网卡 ID。 说明
该参数只对辅助弹性网卡生效。指定一个现有辅助弹性网卡后,您将无法配置其它网卡创建参数。
| eni-bp1gn106np8jhxhj**** |
RxQueueSize | integer | 否 | 弹性网卡入方向队列深度。 您需要注意:
| 8192 |
TxQueueSize | integer | 否 | 弹性网卡出方向队列深度。 您需要注意:
| 8192 |
Tag | array<object> | 否 | 实例、云盘和主网卡的标签信息。 | |
object | 否 | 实例、云盘和主网卡的标签信息。 | ||
Key | string | 否 | 实例、云盘和主网卡的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或 https://。 | TestKey |
Value | string | 否 | 实例、云盘和主网卡的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。 | TestValue |
Ipv6Address | array | 否 | 为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即 N 的取值范围:1~10。 取值示例: 您需要注意:
| |
string | 否 | 为主网卡指定一个或多个 IPv6 地址。支持设置最多 10 个 IPv6 地址,即 N 的取值范围:1~10。 取值示例: 您需要注意:
| 2001:db8:1234:1a00::*** | |
SystemDisk | object | 否 | 系统盘相关参数,目前专属块存储集群 ID( | |
StorageClusterId | string | 否 | 专属块存储集群 ID。如果您在创建 ECS 实例时,需要使用专属块存储集群中的云盘资源作为系统盘,请设置该参数。 | dbsc-j5e1sf2vaf5he8m2**** |
ProvisionedIops | long | 否 | ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50,000}。 说明
当 SystemDisk.Category 取值为cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘。
| 40000 |
BurstingEnabled | boolean | 否 | 是否开启 Burst(性能突发)。取值范围:
说明
当 SystemDisk.Category 取值为cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘。
| false |
Encrypted | string | 否 | 系统盘是否加密。取值范围:
默认值:false。 说明
中国(香港)D 可用区、新加坡 A 可用区暂不支持在创建实例时加密系统盘。
| false |
KMSKeyId | string | 否 | 系统盘对应的 KMS 密钥 ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
EncryptAlgorithm | string | 否 | 说明
该参数暂未开放使用。
| null |
ImageOptions | object | 否 | 镜像相关属性信息。 | |
LoginAsNonRoot | boolean | 否 | 使用该镜像的实例是否支持使用 ecs-user 用户登录。可能值:
| false |
NetworkOptions | object | 否 | 网络相关属性参数。 | |
EnableJumboFrame | boolean | 否 | 实例是否开启 Jumbo frame 特性。参数取值范围:
默认值:true。 说明
只有八代以上部分实例规格支持开启 Jumbo frame 特性。更多信息请参见ECS 实例 MTU。
| false |
AutoPay | boolean | 否 | 创建实例时,是否自动支付。取值范围:
默认值:true。 | true |
PrivateDnsNameOptions | object | 否 | 说明
该参数正在邀测中,暂不开放使用。
| |
EnableInstanceIdDnsARecord | boolean | 否 | 说明
该参数正在邀测中,暂不开放使用。
| false |
EnableInstanceIdDnsAAAARecord | boolean | 否 | 说明
该参数正在邀测中,暂不开放使用。
| true |
EnableIpDnsARecord | boolean | 否 | 说明
该参数正在邀测中,暂不开放使用。
| true |
EnableIpDnsPtrRecord | boolean | 否 | 说明
该参数正在邀测中,暂不开放使用。
| false |
HostnameType | string | 否 | 说明
该参数正在邀测中,暂不开放使用。
| Custom |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"OrderId": "123456****",
"TradePrice": 0.165,
"InstanceIdSets": {
"InstanceIdSet": [
"[\"i-bp67acfmxazb4pd2****\", \"i-bp1i43l28m7u48p1****\", \"i-bp12yqg7jdyxl11f****\"]"
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | LoginAsNonRoot.ImageNotSupport | The specified image does not support login as non-root. | 此镜像不支持NonRoot登录。 |
400 | InvalidParam.NotSupportJumboFrame | Not support jumbo frame. | - |
400 | InsufficientBalance.AgentCredit | Insufficient agent credit. Please contact your agent. | 代理商信用不足,请与您的代理商联系。 |
400 | QuotaExceed.DiskCapacity | The used capacity of disk type has exceeded the quota in the zone, %s. | 指定磁盘类型的已用容量超出可用区配额限制,您可以前往配额中心查询和申请提升磁盘容量配额。 |
400 | InvalidPeriod.ExceededDedicatedHost | Instance expired date can not exceed dedicated host expired date. | 实例过期日期不能超过专有宿主机的过期日期。 |
400 | InvalidParam.SecondaryNetworkInterface | When min amount greater than 1 and the PrivateIpAddress or Primary NetworkInterface is specified,the Secondary NetworkInterface IP parameter cannot be specified. | - |
400 | InvalidPrimaryIpAddress.SizeInvalid | The NetworkInterface PrimaryIpAddress is used to create only one instance. | - |
400 | InvalidStorageClusterId.CapacityNotEnough | The remaining capacity of the current dedicated storage cluster is less than the size of disk. | 磁盘所在专属存储集群的可用容量不足 |
400 | InvalidStorageClusterId.StatusNotSupport | The current status of the dedicated storage cluster cannot create a cloud disk yet. | - |
400 | InvalidStorageClusterId.ZoneIdEmpty | The specified param ZoneId cannot be empty when StorageClusterId given. | - |
400 | InvalidStorageClusterId.PerformanceLevelNotMatch | The current dedicated storage cluster cannot create this performance level of disk. | - |
400 | InvalidStorageClusterId.CategoryNotMatch | The current dedicated storage cluster cannot create this category of disk. | - |
400 | InvalidStorageClusterId.DiskSizeEmpty | The specified param DiskSize cannot be empty when StorageClusterId given. | - |
400 | InvalidInstanceType.ValueUnauthorized | The specified InstanceType is not authorized. | 指定的实例规格未授权使用。 |
400 | InvalidInstanceType.ValueNotSupported | The specified InstanceType beyond the permitted range. | 指定的实例规格不合法(超出可选范围)。 |
400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | 指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。 |
400 | InvalidInternetChargeType.ValueNotSupported | The specified InternetChargeType is not valid. | 暂不支持指定的网络付费类型的实例,请确认相关参数是否正确。 |
400 | InvalidParameter | The specified parameter "InternetMaxBandwidthOut" is not valid. | - |
400 | InvalidHostName.Malformed | The specified parameter "HostName" is not valid. | - |
400 | InvalidPassword.Malformed | The specified parameter "Password" is not valid. | - |
400 | InvalidPasswordParam.Mismatch | The input password should be null when passwdInherit is true. | 启用 PasswdInherit 后,用户名密码应该设置为空。 |
400 | InvalidSystemDiskCategory.ValueNotSupported | The specified parameter "SystemDisk.Category" is not valid. | - |
400 | InvalidDiskName.Malformed | The specified parameter "SyatemDisk.DiskName or DataDisk.n.DiskName" is not valid. | - |
400 | InvalidDiskDescription.Malformed | The specified parameter "SyatemDisk.DiskDescription" or "DataDisk.n.Description" is not valid. | - |
400 | InvalidDataDiskSize.ValueNotSupported | The 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 超出允许范围,或者快照的容量超过指定磁盘类别的大小限制。 |
400 | InvalidDataDiskCategory.ValueNotSupported | The specified parameter "DataDisk.n.Category" is not valid. | - |
400 | InvalidDataDevice.Malformed | The specified parameter "DataDisk.n.Device" is not valid. | - |
400 | InvalidNodeControllerId.Malformed | The specified parameter "NodeControllerId" is not valid. | - |
400 | InvalidInnerIpAddress.Malformed | The specified parameter "InnerIpAddress" is not valid. | - |
400 | InvalidInnerIpAddress.Unusable | The specified InnerIpAddress is already used or not found in usable ip range. | 指定的 InnerIpAddress 不可用。 |
400 | InvalidParameter.Conflict | The specified image does not support the specified instance type. | 指定的镜像不能用于指定的实例规格。 |
400 | ImageNotSupportCloudInit | The specified image does not support cloud-init. | 该镜像不支持CloudInit。 |