接口说明
请确保在使用该接口前,已充分了解 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参考取值来源: DescribeRegions |
ImageIdstring | 镜像文件 ID,启动实例时选择的镜像资源。如需使用云市场镜像,您可以在云市场镜像商详情页查看 示例值:ubuntu_18_04_64_20G_alibase_20190624.vhd参考取值来源: ImportImage CopyImage ExportImage CreateImage DescribeImages |
ImageFamilystring | 镜像族系名称,通过设置该参数来获取当前镜像族系内最新可用镜像来创建实例。展开详情 示例值:hangzhou-daily-update参考取值来源: DescribeImages |
InstanceTypestring | 实例的资源规格。展开详情 示例值:ecs.g6.large参考取值来源: DescribeInstanceTypes |
SecurityGroupIdstring | 指定新创建实例所属于的安全组 ID。 示例值:sg-bp15ed6xe1yxeycg****参考取值来源: CreateSecurityGroup DescribeSecurityGroups |
InstanceNamestring | 实例的名称。长度为 2~128 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文等)和数字。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。如果没有指定该参数,默认值为实例 ID。 示例值:k8s-node-[1,4]-alibabacloud参考取值来源: DescribeInstances ModifyManagedInstance DeregisterManagedInstance |
InternetChargeTypestring | 网络计费类型。取值范围:展开详情 示例值:PayByTraffic |
AutoRenewboolean | 是否要自动续费。当参数 示例值: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****参考取值来源: CreateDeploymentSet DescribeDeploymentSets |
DeploymentSetGroupNointeger<int32> | 如果您设置的部署集对应的策略为部署集组高可用策略(AvailabilityGroup)时,可以通过该参数指定实例在部署集中的分组号。取值范围为 1~7。 示例值:1 |
ZoneIdstring | 实例所属的可用区 ID。更多信息,请参见 DescribeZones 获取可用区列表。展开详情 示例值:cn-hangzhou-g参考取值来源: DescribeZones |
ClusterIdstring | 实例所在的集群 ID。展开详情 示例值:c-bp67acfmxazb4p****参考取值来源: CreateHpcCluster DescribeHpcClusters |
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参考取值来源: DescribeDisks |
SystemDisk.Descriptionstring | 系统盘描述。长度为 2~256 个英文或中文字符,不能以 示例值:TestDescription |
SystemDisk.PerformanceLevelstring | 创建 ESSD 云盘作为系统盘使用时,设置云盘的性能等级。取值范围:展开详情 示例值:PL1 |
NodeControllerIdstring | 说明
该参数正在邀测中,暂不支持使用。
示例值:null |
Descriptionstring | 实例的描述。长度为 2~256 个英文或中文字符,不能以 示例值:InstanceTest |
VSwitchIdstring | 如果是创建 VPC 类型的实例,需要指定交换机 ID。您可以调用 DescribeVSwitches 查询已创建的交换机的相关信息。展开详情 示例值:vsw-bp1s5fnvk4gn2tws0**** |
PrivateIpAddressstring | 实例私网 IP 地址。该 IP 地址必须为交换机(VSwitchId)网段的空闲地址。 示例值:172.16.236.*参考取值来源: AssignPrivateIpAddresses |
IoOptimizedstring | 是否为 I/O 优化实例。取值范围:展开详情 示例值:optimized |
UseAdditionalServiceboolean | 是否使用阿里云提供的虚拟机系统配置(Windows:NTP、KMS;Linux:NTP、YUM)。 示例值:true |
InstanceChargeTypestring | 实例的付费方式。取值范围:展开详情 示例值:PrePaid参考取值来源: DescribeInstances |
Periodinteger<int32> | 购买资源的时长,单位由 示例值:1 |
PeriodUnitstring | 购买资源的时长。取值范围:展开详情 示例值:Month |
UserDatastring | 实例自定义数据,需要以 Base64 方式编码,原始数据最多为 32 KB。 示例值:ZWNobyBoZWxsbyBlY3Mh参考取值来源: DescribeUserData |
SpotStrategystring | 实例的抢占策略。当参数 示例值:NoSpot |
KeyPairNamestring | 密钥对名称。展开详情 示例值:KeyPairTestName参考取值来源: CreateKeyPair DetachKeyPair ImportKeyPair AttachKeyPair DescribeKeyPairs |
SpotPriceLimitnumber<float> | 设置实例的每小时最高价格。支持最多 3 位小数,参数 示例值:0.98 |
SpotDurationinteger<int32> | 抢占式实例的保留时长,单位为小时。默认值:1。取值范围:展开详情 示例值:1取值 <= 6 |
SpotInterruptionBehaviorstring | 抢占实例中断模式。取值范围:展开详情 示例值:Terminate |
RamRoleNamestring | 实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。 示例值:RAMTestName参考取值来源: AttachInstanceRamRole DetachInstanceRamRole DescribeInstanceRamRole |
SecurityEnhancementStrategystring | 是否开启安全加固。取值范围:展开详情 示例值:Active |
ResourceGroupIdstring | 实例所在的企业资源组 ID。 示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSecurityGroups |
HpcClusterIdstring | 实例所属的 HPC 集群 ID。 示例值:hpc-bp67acfmxazb4p****参考取值来源: CreateHpcCluster DescribeHpcClusters |
DryRunboolean | 是否只预检此次请求。取值范围:展开详情 示例值:false |
DedicatedHostIdstring | 是否在专有宿主机上创建 ECS 实例。展开详情 示例值:dh-bp67acfmxazb4p****参考取值来源: AllocateDedicatedHosts DescribeDedicatedHosts |
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( |
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
InstanceIdstring | 实例 ID。 示例值:i-bp67acfmxazb4p**** |
OrderIdstring | 订单 ID。该参数只有创建包年包月 ECS 实例(请求参数 示例值:1234567890 |
TradePricenumber<float> | 订单成交价。 示例值:0.165 |