CreateInstance
本接口是阿里云 ECS 中用于创建实例的接口,支持创建一台包年包月或按量付费的 ECS 实例。您可通过此接口,依据自身需求灵活配置各类参数,实现实例的个性化创建
服务地址:
华东1 金融云
输入参数
只看必填
RegionId实例所属的地域ID
ImageId镜像文件ID
ImageFamily镜像族系名称
InstanceType实例的资源规格
SecurityGroupId指定新创建实例所属于的安全组ID
InstanceName实例的名称
InternetChargeType网络计费类型
AutoRenew是否要自动续费
请选择布尔值
AutoRenewPeriod每次自动续费的时长
InternetMaxBandwidthIn公网入带宽最大值
InternetMaxBandwidthOut公网出带宽最大值
HostName云服务器的主机名
Password实例的密码
PasswordInherit是否使用镜像预设的密码
请选择布尔值
DeploymentSetId部署集ID
DeploymentSetGroupNo如果您设置的部署集对应的策略为部署集组...
ZoneId实例所属的可用区ID
ClusterId实例所在的集群ID
VlanId虚拟局域网ID
InnerIpAddress实例的内网IP
SystemDisk.Size系统盘大小
SystemDisk.Category系统盘的云盘种类
SystemDisk.DiskName系统盘名称
SystemDisk.Description系统盘描述
SystemDisk.PerformanceLevel创建ESSD云盘作为系统盘使用时
NodeControllerId>该参数正在邀测中
Description实例的描述
VSwitchId如果是创建VPC类型的实例
PrivateIpAddress实例私网IP地址
IoOptimized是否为I/O优化实例
UseAdditionalService是否使用阿里云提供的虚拟机系统配置(W...
请选择布尔值
InstanceChargeType实例的付费方式
Period购买资源的时长
PeriodUnit购买资源的时长
UserData实例自定义数据
SpotStrategy实例的抢占策略
KeyPairName密钥对名称
SpotPriceLimit设置实例的每小时最高价格
SpotDuration抢占式实例的保留时长
SpotInterruptionBehavior抢占实例中断模式
RamRoleName实例RAM角色名称
SecurityEnhancementStrategy是否开启安全加固
ResourceGroupId实例所在的企业资源组ID
HpcClusterId实例所属的HPC集群ID
DryRun是否只预检此次请求
请选择布尔值
DedicatedHostId是否在专有宿主机上创建ECS实例
CreditSpecification设置突发性能实例的运行模式
DeletionProtection实例释放保护属性
请选择布尔值
HibernationOptions.Configured>该参数正在邀测中
请选择布尔值
Affinity专有宿主机实例是否与专有宿主机关联
Tenancy是否在专有宿主机上创建实例
StorageSetId存储集ID
StorageSetPartitionNumber存储集中的最大分区数量
HttpEndpoint是否启用实例元数据的访问通道
HttpTokens访问实例元数据时是否强制使用加固模式(...
HttpPutResponseHopLimit>该参数暂未开放使用
PrivatePoolOptions.MatchCriteria实例启动的私有池容量选项
PrivatePoolOptions.Id私有池ID
DataDisk数据盘列表
0
PerformanceLevel创建ESSD云盘作为数据盘使用时
Description数据盘描述
SnapshotId创建数据盘N使用的快照
Size第n个数据盘的容量大小
Device数据盘的挂载点
DiskName数据盘名称
Category数据盘N的云盘种类
DeleteWithInstance数据盘是否随实例释放
请选择布尔值
KMSKeyId云盘使用的KMS密钥ID
EncryptAlgorithm>该参数暂未开放使用
Encrypted数据盘N是否加密
请选择布尔值
StorageClusterId专属块存储集群ID
Arn>该参数正在邀测中
0
RoleType>该参数正在邀测中
Rolearn>该参数正在邀测中
AssumeRoleFor>该参数正在邀测中
Tag标签列表
0标签列表
key标签键
Key实例、云盘和主网卡的标签键
Value实例、云盘和主网卡的标签值
value标签值
SystemDisk系统盘相关参数
StorageClusterId专属块存储集群ID
幂等性参数
ClientToken保证请求幂等性
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

说明 本接口已停止迭代更新,建议您使用 RunInstances 接口。

请确保在使用该接口前,已充分了解 ECS 产品的收费方式和价格

本接口为异步接口,当前创建实例请求发送成功后会返回实例 ID,实例的创建不是立即完成的,需要调用 DescribeInstanceStatus 查看实例信息,当返回信息中的状态为Stopped时代表创建成功,之后您可以通过 StartInstance 启动实例。

使用须知

  • 请确保您的账号已通过实名认证。更多信息,请参见账号实名认证相关文档

  • 创建实例会涉及资源计费,请确保您已了解云服务器 ECS 的计费方式。更多信息,请参见计费概述

  • 请确保您创建的实例总数或者全实例规格 vCPU 不会超出系统配额。更多信息,请参见配额中心

  • 创建专有网络 VPC 类型实例前,请预先在相应的阿里云地域创建 VPC

注意事项

  • 若实例计费方式为包年包月(PrePaid),在付款时默认会使用您可用的优惠券。
  • 实例内存为 512 MiB 时,不能使用除半年渠道之外的 Windows Server 镜像;实例内存为 4 GiB 以上时,不能使用 32 位操作系统的镜像。
  • 使用该接口创建的实例将不会分配公网 IP 地址,若公网带宽大于 0,您可以调用 AllocatePublicIpAddress 分配;若公网带宽为 0,您需要调用 ModifyInstanceNetworkSpec 调整带宽之后再调用 AllocatePublicIpAddress 分配。
说明 单个地域下,单个阿里云账号按固定带宽计费的公网带宽峰值总和存在限制,请参见公网带宽限制

使用建议

  • 产品选型:参见实例规格族或调用 DescribeInstanceTypes 查看目标实例规格的性能数据,或者参见选型配置了解如何选择实例规格。
  • 查询库存:调用 DescribeAvailableResource 查看指定地域或者可用区内的资源供给情况。
  • 自定义数据:若实例满足使用实例自定义数据的限制,您可传入 UserData 信息。发送 API 请求时,不会加密您设置的UserData数据,建议您不要以明文方式传入机密的信息,例如密码和私钥等。如果必须传入,建议加密后以 Base64 的方式编码后再传入,在实例内部解密后使用。

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou
ImageIdstring

镜像文件 ID,启动实例时选择的镜像资源。如需使用云市场镜像,您可以在云市场镜像商详情页查看ImageId。当您不通过指定ImageFamily选用镜像族系最新可用镜像时,此参数必选。

示例值:ubuntu_18_04_64_20G_alibase_20190624.vhd
ImageFamilystring

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

示例值:hangzhou-daily-update
InstanceTypestring

实例的资源规格。展开详情

示例值:ecs.g6.large
SecurityGroupIdstring

指定新创建实例所属于的安全组 ID。

示例值:sg-bp15ed6xe1yxeycg****
InstanceNamestring

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

示例值:k8s-node-[1,4]-alibabacloud
InternetChargeTypestring

网络计费类型。取值范围:展开详情

示例值:PayByTraffic
AutoRenewboolean

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

示例值:true
AutoRenewPeriodinteger<int32>

每次自动续费的时长,当参数 AutoRenew 取值 True 时,该参数为必填参数。展开详情

示例值:2
InternetMaxBandwidthIninteger<int32>

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

示例值:50取值 <= 200
InternetMaxBandwidthOutinteger<int32>

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

示例值:5
HostNamestring

云服务器的主机名。展开详情

示例值:LocalHostName
Passwordstring

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

示例值:TestEcs123!
PasswordInheritboolean

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

示例值:false
DeploymentSetIdstring

部署集 ID。

示例值:ds-bp1brhwhoqinyjd6****
DeploymentSetGroupNointeger<int32>

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

示例值:1
ZoneIdstring

实例所属的可用区 ID。更多信息,请参见 DescribeZones 获取可用区列表。展开详情

示例值:cn-hangzhou-g
ClusterIdstring

实例所在的集群 ID。展开详情

示例值:c-bp67acfmxazb4p****
ClientTokenstring

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

示例值:123e4567-e89b-12d3-a456-426655440000
VlanIdstring

虚拟局域网 ID。

示例值:10
InnerIpAddressstring

实例的内网 IP。

示例值:192.168.**.**
SystemDisk.Sizeinteger<int32>

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

示例值:40
SystemDisk.Categorystring

系统盘的云盘种类。取值范围:展开详情

示例值:cloud_ssd
SystemDisk.DiskNamestring

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

示例值:SystemDiskName
SystemDisk.Descriptionstring

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

示例值:TestDescription
SystemDisk.PerformanceLevelstring

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

示例值:PL1
NodeControllerIdstring
说明 该参数正在邀测中,暂不支持使用。
示例值:null
Descriptionstring

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

示例值:InstanceTest
VSwitchIdstring

如果是创建 VPC 类型的实例,需要指定交换机 ID。您可以调用 DescribeVSwitches 查询已创建的交换机的相关信息。展开详情

示例值:vsw-bp1s5fnvk4gn2tws0****
PrivateIpAddressstring

实例私网 IP 地址。该 IP 地址必须为交换机(VSwitchId)网段的空闲地址。

示例值:172.16.236.*
IoOptimizedstring

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

示例值:optimized
UseAdditionalServiceboolean

是否使用阿里云提供的虚拟机系统配置(Windows:NTP、KMS;Linux:NTP、YUM)。

示例值:true
InstanceChargeTypestring

实例的付费方式。取值范围:展开详情

示例值:PrePaid
Periodinteger<int32>

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

示例值:1
PeriodUnitstring

购买资源的时长。取值范围:展开详情

示例值:Month
UserDatastring

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

示例值:ZWNobyBoZWxsbyBlY3Mh
SpotStrategystring

实例的抢占策略。当参数InstanceChargeType取值为PostPaid时生效。取值范围:展开详情

示例值:NoSpot
KeyPairNamestring

密钥对名称。展开详情

示例值:KeyPairTestName
SpotPriceLimitnumber<float>

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

示例值:0.98
SpotDurationinteger<int32>

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

示例值:1取值 <= 6
SpotInterruptionBehaviorstring

抢占实例中断模式。取值范围:展开详情

示例值:Terminate
RamRoleNamestring

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

示例值:RAMTestName
SecurityEnhancementStrategystring

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

示例值:Active
ResourceGroupIdstring

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

示例值:rg-bp67acfmxazb4p****
HpcClusterIdstring

实例所属的 HPC 集群 ID。

示例值:hpc-bp67acfmxazb4p****
DryRunboolean

是否只预检此次请求。取值范围:展开详情

示例值:false
DedicatedHostIdstring

是否在专有宿主机上创建 ECS 实例。展开详情

示例值:dh-bp67acfmxazb4p****
CreditSpecificationstring

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

示例值:Standard
DeletionProtectionboolean

实例释放保护属性,指定是否支持通过控制台或 API( DeleteInstance )释放实例。展开详情

示例值:false
HibernationOptions.Configuredboolean
说明 该参数正在邀测中,暂不支持使用。
示例值:false
Affinitystring

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

示例值:default
Tenancystring

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

示例值:default
StorageSetIdstring

存储集 ID。

示例值:ss-bp1j4i2jdf3owlhe****
StorageSetPartitionNumberinteger<int32>

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

示例值:2取值 >= 1
HttpEndpointstring

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

示例值:enabled
HttpTokensstring

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

示例值:optional
HttpPutResponseHopLimitinteger<int32>
说明 该参数暂未开放使用。
示例值:0
PrivatePoolOptions.MatchCriteriastring

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

示例值:Open
PrivatePoolOptions.Idstring

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

示例值:eap-bp67acfmxazb4****
DataDiskarray<object>

数据盘列表。

子级条数 <= 16
Arnarray<object>
说明 该参数正在邀测中,暂不支持使用。
子级条数 <= 10
Tagarray<object>

标签列表。

子级条数 <= 20
SystemDiskobject

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

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InstanceIdstring

实例 ID。

示例值:i-bp67acfmxazb4p****
OrderIdstring

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

示例值:1234567890
TradePricenumber<float>

订单成交价。

示例值:0.165
变更历史
暂无变更历史