RunInstances

InstanceTypeId

String

是

ecs.g1ie.xlarge

实例的规格。

• 产品选型：您可以参考实例规格介绍或者调用DescribeInstanceTypes查看实例规格的性能数据，也可以参考实例选型最佳实践了解如何选择实例规格。

• 查询库存：您可以调用DescribeAvailableResource查询可用区中计算资源的库存信息。

InstanceName

String

是

instance-test

实例的名称。

• 以字母或中文开头。

• 只能包含中文、字母、数字、下划线“_”、中划线“-”和点号“.”。

• 长度限制为1～128个字符。

Description

String

否

用于测试的云服务器实例

实例的描述，默认为空字符串。

• 必须以字母或中文开头。

• 只能包含中文、字母、数字、点号“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。”

• 长度限制在255个字符以内。

Hostname

String

否

instance-host-name

实例主机名，即实例操作系统内部的计算机名。

• Linux实例：

  • 允许使用字母、数字、点号“.”或中划线“-”。

  • 不能以中划线、点号开头或结尾，且不能连续使用中划线和点号。

  • Linux系统长度限制在2～63个字符之间。

• Windows实例：

  • 允许使用字母、数字或中划线“-”，不能完全是数字。

  • 不能以中划线开头或结尾，且不能连续使用中划线。

  • Windows系统长度限制在2～15个字符之间。

如不填，则遵循以下规则自动生成：

• 结构：iv- + 初始主机名，例如
  iv-3tigy72q3u3vj0******。
  已创建实例保持原主机名生成逻辑，不随实例重启发生变化。
• 初始主机名生成逻辑：
  • Linux：提取实例IDi-之后的全部字符。
  • Windows：提取实例IDi-之后的后12位字符。

UniqueSuffix

Boolean

否

false

表示当创建多台实例时，是否为Hostname和InstanceName自动添加有序后缀，取值：

• true：开启有序后缀。

• false（默认）：关闭有序后缀。

MinCount

Integer

否

2

指定ECS实例最小创建数量，取值范围：1～100。

• 实例最小创建数量MinCount ≤ 创建数量Count。
• 当库存数量 > 创建数量Count，按Count创建。
• 当最小创建数量MinCount ≤ 库存数量 ≤ 创建数量Count，按库存数量创建。
• 当库存数量 < 最小创建数量MinCount，会因库存不足而创建失败。

DryRun

Boolean

否

false

是否只预检此次请求，取值：

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

  说明

  当DryRun取值为true时，若传入了Count或Mincount参数，则取值必须为1。

• false（默认）：发送正常请求，通过检查后直接创建实例。

Password

String

否

password@123

如需使用“密码”方式登录实例，请通过该参数指定实例的管理员账号初始登录密码。其中Linux管理员账号为root，Windows管理员账号为Administrator。

密码复杂度要求如下：

• 长度限制在8～30之间。

• 密码只能由大写字母、小写字母、数字和特殊字符组成，且必须包含至少三项。

• 特殊字符可以使用：`~!@#$%^&*()_-+=|{}[]:;'<>,.?/

• 不能以“/”和“$6$”开头。

KeyPairName

String

否

kp-test-123

如需使用“SSH密钥”方式登录实例，请指定已创建密钥对的名称。
您可以调用DescribeKeyPairs查看已创建的密钥对；如无可用，请调用CreateKeyPair创建密钥对。

KeepImageCredential

Boolean

否

true

是否保留镜像设置，取值：

• true：保留镜像设置，保留后将使用镜像预设的密码或密钥对登录实例。

• false（默认）：不保留镜像设置。

InstallRunCommandAgent

Boolean

否

false

创建实例时是否安装批量作业Agent，取值：

• true：创建时安装。
• false（默认）：创建时不安装。

Volumes.N.VolumeType

String

否

Volumes.1.VolumeType=ESSD_PL0&Volumes.2.VolumeType=ESSD_PL0

云盘的类型，取值：

• ESSD_PL0：极速型SSD PL0

• ESSD_FlexPL：极速型SSD FlexPL

Volumes.N.Size

Integer

是

Volumes.1.Size=100&Volumes.2.Size=100

云盘的容量，单位为GiB，取值：

• 系统盘：

  • ESSD_PL0：20～2048

  • ESSD_FlexPL：20～2048

• 数据盘：

  • ESSD_PL0：10～32768

  • ESSD_FlexPL：10～32768

Volumes.N.DeleteWithInstance

Boolean

否

Volumes.1.
DeleteWithInstance=true&Volumes.2.
DeleteWithInstance=false

云盘是否随实例释放，取值：

• true（默认）：云盘随实例释放。

• false：云盘不随实例释放。

Volumes.N.SnapshotId

String

否

Volumes.1.SnapshotId=snap-31akybwsxi8rudc6****&Volumes.2.SnapshotId=snap-31ak39j5bh8rubsn****

使用快照创建云盘，仅支持创建数据盘。您可以调用DescribeSnapshots接口查询快照ID。

• 参数 - N：表示云盘的序号，取值范围：1～16。N = 1表示系统盘，故N传入1时，该参数将被忽略。N ≥ 2表示数据盘，可正常传入目标数据盘快照ID。

• 多个云盘之间用&分隔。

NetworkInterfaces.N.SubnetId

String

是

NetworkInterfaces.1.SubnetId=subnet-3tispp1nai4e8i******& NetworkInterfaces.2.SubnetId=subnet-2ff1nczrx2lts5oxru******

实例的私有网络子网ID，创建实例时，支持同时绑定辅助网卡。

• 参数 - N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。

• 多个私有网络子网ID之间用&分隔。

NetworkInterfaces.N.PrimaryIpAddress

String

否

NetworkInterfaces.1.PrimaryIpAddress=192.168.**.**

指定网卡的主IP地址，当前仅支持为主网卡或辅助网卡指定一个主IP地址。

• 参数 - N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。

• 多个网卡之间用&分隔。

NetworkInterfaces.N.PrivateIpAddresses.N

String

否

NetworkInterfaces.1.PrivateIpAddresses.1=172.16.**.**&NetworkInterfaces.1.PrivateIpAddresses.2=172.16.**.**

指定主网卡的辅助IP地址，当前只支持主网卡指定辅助IP。

• 第一个N：表示主网卡的序号，当前仅支持绑定一张主网卡。

• 第二个N：表示主网卡的辅助IP序号，最多可分配的辅助IP地址的数量为该实例规格的单网卡私有IP数减去一个主私网IP。

• 多个辅助IP之间用&分隔。

NetworkInterfaces.N.SecurityGroupIds.N

String

是

NetworkInterfaces.1.SecurityGroupIds.1=sg-3ti78x9h8t4bw*****& NetworkInterfaces.2.SecurityGroupIds.1=sg-3cj59ih2v9hj46c6rr******

网卡关联的安全组ID。

• 第一个N：表示网卡的序号，N = 1表示主网卡；N ≥ 2表示辅助网卡。

• 第二个N：表示网卡关联的安全组的序号，取值范围：1～5。

• 多个安全组ID之间用&分隔。

InstanceChargeType

String

否

PostPaid

实例和云盘的计费类型，取值：

• PostPaid（默认）：按量计费。

• PrePaid：包年包月。请确认您的账号支持余额支付或者信控支付，否则将返回InvalidInstanceChargeType的错误提示。

SpotStrategy

String

否

NoSpot

按量计费实例的抢占式策略，取值：

• NoSpot（默认）：表示创建正常按量计费实例。

• SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。

• SpotWithPriceLimit：设置出价上限的抢占式实例。

SpotPriceLimit

Float32

否

0.78

抢占式实例的每小时最高价格，支持最大3位小数。

CreditSpecification

String

否

Standard

突发性能实例的运行模式，取值：
Standard：标准模式

UserData

String

否

ZWNobyBoZWxsbyBlY3Mh

实例自定义数据。设置的自定义数据必须经过Base64编码，且Base64编码前的自定义数据大小不能超过16KB。

Period

Integer

否

12

购买资源的时长（月）。

• 取值：1、2、3、4、5、6、7、8、9、12、24、36
• 默认值：1

PeriodUnit

String

否

Month

购买资源的时长单位，取值：Month（默认）。

AutoRenew

Boolean

否

true

实例到期后是否自动续费。

• true：自动续费。

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

AutoRenewPeriod

Integer

否

1

每次自动续费的时长。

ClientToken

String

否

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

ProjectName

String

否

project_a

资源所属项目，一个资源只能归属于一个项目。

• 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
• 长度限制在64个字符以内。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

用户标签的标签键。

• 参数 - N：表示标签键的序号，取值范围：1～20。

• 多个标签键之间用&分隔。

• 不能以volc:或sys:的任意大小写组合开头。

• 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

• 长度限制在1～128个字符之间。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

用户标签的标签值。

• 参数 - N：表示标签值的序号，取值范围：1～20。

• 多个标签值之间用&分隔。

• 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

• 允许为空，长度限制在0～256个字符之间。

DeploymentSetId

String

否

dps-yc1o9aahks5m57nk****

实例需要加入的部署集ID。

DeploymentSetGroupNumber

Integer

否

1

部署集组的序号，取值范围：1～3。
当实例要加入或调整的部署集策略为部署集组高可用（AvailabilityGroup）时，需传入该参数。

Placement.Tenancy

Boolean

否

Default

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

• Default（默认）：创建普通云服务器实例。

• Host：创建专有宿主机实例。若您不指定DedicatedHostId，则由系统自动选择专有宿主机放置实例。

Placement.DedicatedHostId

String

否

dh-bp67acfmxazb4p****

实例所在的专有宿主机ID。
您可以调用DescribeDedicatedHosts接口查询专有宿主机列表。

Placement.Affinity

String

否

Host

针对节省停机模式的ECS实例，停止后会释放部分资源，本参数用于选择ECS实例重新启动时是否仍固定部署在原宿主机上。取值：

• Host：启用节省停机模式的实例重新启动时，仍会部署在原宿主机上。
• Default（默认）：启用节省停机模式的实例重新启动时，会优先迁移到支持自动部署的宿主机；若支持自动部署的宿主机资源不足，则在原宿主机上进行启动。

Placement.DedicatedHostClusterId

String

否

dc-ycle6b76kgv2wrsm****

实例所在的专有宿主机集群ID。
您可以调用DescribeDedicatedHostClusters接口查询宿主机集群ID。

EipAddress.ChargeType

String

否

PayByBandwidth

公网IP的计费方式，取值：

• PayByBandwidth（默认）：按量计费-按带宽上限计费。

• PayByTraffic：按量计费-按实际流量计费。

• PrePaid：包年包月。

EipAddress.ISP

String

否

BGP

公网IP的线路类型，默认为BGP。取值：

• BGP：BGP（多线）。

• 若您的账号已申请并开通了静态单线权限，则可传入如下取值：

  • ChinaMobile：中国移动静态单线。

  • ChinaTelecom：中国电信静态单线。

  • ChinaUnicom：中国联通静态单线。

• 若您的账号已申请并开通了BGP单线权限，则可传入SingleLine_BGP。

• 若您的账号已申请并开通了静态BGP权限，则可传入Static_BGP。

EipAddress.BandwidthMbps

Integer

否

5

公网IP的带宽上限，默认值1，单位：Mbps。

• ChargeType传入PayByBandwidth：取值范围1 ~ 500。

• ChargeType传入PayByTraffic：取值范围1 ~ 200。

EipAddress.BandwidthPackageId

String

否

bwp-2zeo05qre24nhrqpy****

共享带宽包的ID，表示将公网IP加入到共享带宽包。
您可以调用 DescribeBandwidthPackages 接口，查询共享带宽包的ID。
公网IP加入到共享带宽包必须同时满足如下条件：

• 二者的安全防护类型相同。

• 二者的地域相同。

• 公网IP的计费方式必须是按量计费。

EipAddress.ReleaseWithInstance

Boolean

否

false

公网IP是否随实例删除，仅按量计费公网IP生效。取值：

• true：公网IP随实例删除。当实例被系统自动回收（退订24小时后、到期回收等）或被调用DeleteInstance、DeleteInstances接口删除时，公网IP随实例一同释放。

• false（默认）：公网IP不随实例删除。

EipAddress.SecurityProtectionTypes.N

String

否

SecurityProtectionTypes.1 =AntiDDoS_Enhanced

公网IP的安全防护类型。

• 参数 - N：表示安全防护类型的序号，当前仅支持取1。

• 取值：

  • AntiDDoS_Enhanced：申请增强防护类型的公网IP，可加入到DDoS原生防护（企业版）实例。

    说明

    • 若传入AntiDDoS_Enhanced，则EipAddress.ChargeType不能为PrePaid，且EipAddress.ISP必须传入BGP。

    • 增强防护类型公网IP正在邀测中，如需试用，请提交工单或联系客户经理申请。

  • 不填则表示申请默认防护类型的公网IP。

EipAddress.SecurityProtectionInstanceId

Integer

否

20

DDoS原生防护（企业版）ID。

• 您可以调用DescInstanceList接口，查询DDoS原生防护（企业版）的ID。

• 当SecurityProtectionTypes传入AntiDDoS_Enhanced时，此参数必须传入。

400

LimitExceeded.MaximumTags

You've reached the limit on the number of tags that you can create.

指定的标签数量超过最大限制。

400

InvalidPlacementAffinity.Malformed

The specified placement affinity is malformed.

指定的Placement.Affinity不合法。

400

QuotaExceeded.MaximumEips

You've reached the limit on the number of EIP that you can create, please submit ticket to request an increase in quota.

公网IP配额不足，请提工单申请提高配额。

400

InvalidSnapshotStatus

The specified snapshot state does not support create a cloud disk.

指定的快照状态不支持创建云盘。

400

InvalidVolumeTypeForSnapshot.UnSupported

The specified VolumeType cannot be used for create snapshot.

指定的云盘类型不支持快照。