RunInstances - 云服务器 ECS

系统规定参数。取值：RunInstances

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

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

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

• 设置了参数ImageId，则不能设置该参数。
• 未设置参数ImageId，但指定的LaunchTemplateId或LaunchTemplateName对应的启动模板设置了ImageId，则不能设置该参数。
• 未设置ImageId，且指定的LaunchTemplateId或LaunchTemplateName对应的启动模板未设置ImageId，则可以设置该参数。
• 未设置ImageId，且未设置LaunchTemplateId、LaunchTemplateName参数，则可以设置该参数。

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

• 产品选型：参见实例规格族或调用DescribeInstanceTypes查看目标实例规格的性能数据，或者参见选型配置了解如何选择实例规格。
• 查询库存：调用DescribeAvailableResource查看指定地域或者可用区内的资源供给情况。

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

如果您不指定LaunchTemplateId或LaunchTemplateName以确定启动模板，SecurityGroupId为必选参数。

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

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

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

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

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

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

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

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

默认值：0

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

• 半角句号（.）和短划线（-）不能作为首尾字符，更不能连续使用。
• 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参数不能同时设置。

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

• N的个数需要和Amount参数值保持一致。
• 不支持同时设置HostName参数和HostNames.N参数。
• 半角句号（.）和短划线（-）不能作为首尾字符，更不能连续使用。
• Windows实例：字符长度为2~15，不支持半角句号（.），不能全是数字。允许包含大小写英文字母、数字和短划线（-）。
• 其他类型实例（Linux等）：字符长度为2~64，支持多个半角句号（.），点之间为一段，每段允许包含大小写英文字母、数字和短划线（-）。

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

• true：添加
• false：不添加

默认值：false

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

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

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

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

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

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

• true：使用
• false：不使用

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

默认值：系统自动选择。

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

• PayByBandwidth：按固定带宽计费
• PayByTraffic（默认）：按使用流量计费

系统盘大小，单位为GiB。取值范围：20~500

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

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

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

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

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

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

默认值：空

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

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

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

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

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

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

• cloud_efficiency：20~32768
• cloud_ssd：20~32768
• cloud_essd：20~32768
• cloud：5~2000

该参数的取值必须大于等于参数SnapshotId指定的快照的大小。

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

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

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

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

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

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

• true：加密
• false：不加密

默认值：false

数据盘对应的KMS密钥ID。

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

默认值：空

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

数据盘的挂载点。

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

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

默认值：true

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

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

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

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

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

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

添加一张辅助弹性网卡并设置主IP地址。N的取值范围为1。

默认值：从网卡所属的交换机网段中随机选择一个IP地址。

辅助弹性网卡所属的虚拟交换机ID。N的取值：1

默认值：ECS实例所属的虚拟交换机。

辅助弹性网卡所属的安全组ID。N的取值：1

默认值：实例所属的安全组。

将辅助弹性网卡同时加入多个安全组。SecurityGroupIds.N中N的取值范围与弹性网卡实例能够加入安全组配额有关，更多详情，请参见使用限制。

辅助弹性网卡名称。N的取值：1

辅助弹性网卡的描述。N的取值：1。长度为2~256个英文或中文字符，不能以http://和https://开头。

辅助弹性网卡队列数。N的取值：1

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

实例自定义数据。需要以Base64方式编码，原始数据最多为16 KB。

密钥对名称。

• Windows实例，忽略该参数。默认为空。即使填写了该参数，仍旧只执行Password的内容。
• Linux实例的密码登录方式会被初始化成禁止。

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

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

默认值：1

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

• 当ECS库存数量小于最小购买数量，会创建失败。
• 当ECS库存数量大于等于最小购买数量，按照库存数量创建。

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

• 如果秒（ss）取值不是00，则自动取为当前分钟（mm）开始时。
• 最短释放时间为当前时间半小时之后。
• 最长释放时间不能超过当前时间三年。

按量实例的抢占策略。当参数InstanceChargeType取值为PostPaid时生效。取值范围：

• NoSpot（默认）：正常按量付费实例
• SpotWithPriceLimit：设置上限价格的抢占式实例
• SpotAsPriceGo：系统自动出价，跟随当前市场实际价格

抢占式实例的保留时长，单位为小时。取值范围：0~6

• 保留时长2~6正在邀测中，如需开通请提交工单。
• 取值为0，则为无保护期模式。

默认值：1

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

抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。

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

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

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

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

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

实例所属的EHPC集群ID。

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

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

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

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

启动模板ID。更多详情，请调用DescribeLaunchTemplates。

使用启动模板创建实例时，您必须指定LaunchTemplateId或LaunchTemplateName确定启动模板。

启动模板名称。

使用启动模板创建实例时，您必须指定LaunchTemplateId或LaunchTemplateName确定启动模板。

启动模板版本。如果您指定了LaunchTemplateId或LaunchTemplateName而不指定启动模板版本号，则采用默认版本。

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

购买资源的时长，单位由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”}。

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

• Week
• Month（默认）

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

• true：自动续费
• false（默认）：不自动续费

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

• PeriodUnit=Week时：{“1”, “2”, “3”}。
• PeriodUnit=Month时：{“1”, “2”, “3”, “6”, “12”, "24", "36", "48", "60"}。

默认值：1

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

• PrePaid：包年包月
• PostPaid（默认）：按量付费

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

部署集ID。

实例私网IP地址。

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

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

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

默认值：无

为主网卡指定一个IPv6地址。目前，N的取值范围仅支持1。取值示例：Ipv6Address.1=2001:db8:1234:1a00::***。

为主网卡指定随机生成的IPv6地址数量。

主网卡队列数。

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

实例释放保护属性，指定是否支持通过控制台或API（DeleteInstance）释放实例。取值范围：

• true：开启实例释放保护
• false（默认）：关闭实例释放保护

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

• default：实例不与专有宿主机关联。已开启停机不收费功能的实例，停机后再次启动时，若原专有宿主机可用资源不足，则实例被放置在自动部署资源池的其它专有宿主机上。
• host：实例与专有宿主机关联。已开启停机不收费功能的实例，停机后再次启动时，仍放置在原专有宿主机上。若原专有宿主机可用资源不足，则实例重启失败。

默认值：default

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

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

默认值：default

存储集ID。

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

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

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

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

• CpuOptions.ThreadPerCore=1表示关闭CPU超线程。
• 仅部分实例规格支持设置CPU线程数。

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

CPU Numa节点数。

可信系统模式。取值：vTPM

目前，可信系统模式支持的实例规格族：g7、c7、r7以及七代安全增强型（g7t、c7t、r7t）。

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

• 如果您使用阿里云可信系统，请将该参数值设置为vTPM，在实例启动时即可通过阿里云可信系统完成可信校验。
• 如果您不使用阿里云可信系统，可以不设置该参数值。

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

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

• enabled：启用
• disabled：禁用

默认值：enabled

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

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

默认值：optional

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

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

默认值：None

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

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

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

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

在您同时指定了专有宿主机（DedicatedHostId）和专有宿主机集群（SchedulerOptions.DedicatedHostClusterId）时：

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

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

实例ID（InstanceIdSet）列表。

请求ID。

订单成交价。

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