新版创建云主机

接口说明

本接口用于创建云主机。 该接口会创建云主机并创建订单,支持按量、按月、包年订购云主机产品,订购按月预付费及包年预付费云主机产品时,将会返回支付链接,需用户自行前往该链接支付。 本接口正常支持最大300并发。

计费:
1. 创建实例会涉及资源计费,建议您提前了解云服务器 ECS 的计费方式。更多详情,请参见云主机计费规则。
2. 请妥善保管AccessKey,以防通过接口产生不知情订购资费。

存储: 根据您指定的镜像,实例被分配一个相应大小的系统盘。系统盘的种类请参见bootVolume.volumeType参数描述。 系统盘类型(highPerformance/performanceOptimization)可以选择高性能型系统盘(highPerformance)、性能优化型系统盘(performanceOptimization)。 一台实例最多添加5块数据盘。

自定义数据: 您可传入UserData信息。因为传输API请求时,不会加密您设置的UserData,建议不要以明文方式传入机密的信息,例如密码和私钥等。如果必须传入,建议自行加密后,在实例内部以同样的方式反解密。

password参数: 采用RSA对明文加密,公钥内容详见接口说明,用户可用该公钥自行加密明文得到密文。明文8-16位字符,同时包括数字、大小写字母和特殊字符,其中不能出现3个及以上连续或重复的数字,如123、111等,以及特殊字符最多不能超过3个,且需要在“~ @ # $ % * _ - + = , . ? [ ] { }”范围内。(password和keypairName仅能填写一个 )不建议使用包含姓名、电话、出生日期、账号名、系统名以及公司名的密码;不建议使用包含连续的字母、键位或重复的字母、字符的密码,比如abc、asd、@#$、AAA、###等。

公钥内容:

-----BEGIN PUBLIC KEY----- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC/VpRysi0bPRLS7sbgQDJHo1MAt9/bK +nwK5Pe3z0/O4cH5I/8kFNYy4yFsLMM+zyFvVw9C4wzjHaRcmEuF3ziJMC9PD5ufUWgfO 5nSGgZW1cmgjqnhcWJ3i+Azj72RnhKQRCn9DgJduEC9MiKfbyTICGd6FXf9cxb21nkxI7vtwIDAQAB -----END PUBLIC KEY-----

其他注意事项: 由于海光芯片与Windows系统存在已知的兼容性差异,使用此组合可能导致性能未达最优或偶发不稳定,如启动阶段蓝屏、系统崩溃等问题。建议您在生产部署业务前充分进行兼容性测试。

本接口用于订购云主机,相比于老接口,主要更新如下:
1. 使用规格名称specsName代替cpu,ram和规格类型vmType,specsName唯一指代一个规格。
2. 使用镜像ID(imageId)代替镜像名称(imageName)。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/orderServer

请求参数

Body

参数名称
类型
必填
描述
serverApiCreateReqV2
ServerApiCreateReqV2
是

创建云主机请求体。

autoRenew
boolean
否

是否自动续订。

groupId
string
否

关联群组ID。

imagePresets
boolean
否

是否使用镜像预设密码

tags
<Tag> array
否

标签列表。
说明:
1. 一次绑定的标签不能超过10个;
2. 标签的键值不能以ecloud开头;
3. 标签可绑定云主机和系统盘资源。

key
string
是

标签键,标签键仅支持数字、中英文、中划线、下划线,长度在1-127位之间,且不可重复不能以'ecloud'开头。

value
string
是

标签值,标签值仅支持数字、中英文、中划线、下划线,长度在1-255位之间,不能以'ecloud'开头。

volumeIds
<string> array
否

挂载数据盘id。

region
string
是

可用区(可通过查询可用区接口获取),示例:北京3可用区1的region为BJJD。

billingType
enum(MONTH,YEAR,HOUR)
是

付费方式。

duration
integer(int32)
否

订购时长(月/年),按量付费填写0;
包月后付费(政企集团或省集团客户)填写需要订购的时长,取值范围为[0,60],如果取值为0,会设置成订购一个月并开启自动续订,1-60表示具体订购的月数;
包月预付费(互联网客户)填写需要订购的时长,取值范围为[1,12],1-12表示具体订购的月数;
包年付费填写需要订购的年数,取值范围为[1,5];
说明:该参数在按量或包月后付费默认为0。

quantity
integer(int32)
否

订购数量,范围在[1,300]间。

specsName
string
是

规格名称,可从查看云主机可用规格列表-新版获取当前资源池可用规格。

imageId
string
是
bootVolume
ServerCreateBootVolumeReq
是

系统盘。

size
integer(int32)
是

系统盘大小(GB),Linux系统盘大小为max{20, 镜像大小},Windows系统盘最小为max{40, 镜像大小},最大均为2048。

volumeType
enum(highPerformance,performanceOptimization,highPerformanceyc,performanceOptimizationyc,extremePerformanceL1,extremePerformanceL1yc)
是

系统盘类型。

  • highPerformance:高性能型。
  • highPerformanceyc:高性能型-云创。
  • performanceOptimization:性能优化型。
  • performanceOptimizationyc:性能优化型-云创。
  • extremePerformanceL1:极速型L1。
  • extremePerformanceL1yc:极速型L1-云创。
dataVolume
<ServerCreateDataVolumeReq> array
否

一体化订购中数据盘产品。可查询当前地域支持的数据盘类型。

isShare
boolean
否

是否为共享数据盘,默认为非共享盘。

keyId
string
否

密钥id,云硬盘加密功能

size
integer(int32)
否

系统盘大小(GB),Linux系统盘大小为max{20, 镜像大小},Windows系统盘最小为max{40, 镜像大小},最大均为2048。

volumeType
enum(capebs,ssd,ssdebs,capebsyc,ssdyc,ssdebsyc)
是

系统盘类型,highPerformance:高性能型;highPerformanceyc:高性能型-云创;performanceOptimization:性能优化型;performanceOptimizationyc:性能优化型-云创。

networks
ServerCreateNetworkReq
是

云主机网络请求体,查询虚拟网卡列表。

initialIp
string
否

指定IP地址。

networkId
string
是

查询VPC下网络对应返参中的id。

publicIp
ServerCreateIpReq
否

一体化订购公网IP产品。如需一体化订购公网IP产品,必须一起填写publicIp与bandwidth参数(不可与bindPublicIp参数同时填写,因暂不支持同时订购新的公网IP与绑定已有公网IP)。

ipType
enum(MOBILE,MULTI_LINE)
否

公网IP类型,MOBILE:弹性公网IP;MULTI_LINE:优享版弹性公网IP。

bandwidth
ServerCreateBandwidthReq
否

一体化订购中带宽产品。

bandwidthSize
integer(int32)
是

公网IP带宽大小 (Mbps),取值范围为[1,500]。如需订购更大带宽,请通过工单申请订购权限。

chargeMode
enum(bandwidthCharge,trafficCharge)
是

公网IP带宽计费方式,bandwidthCharge:按带宽计费;trafficCharge:按流量计费。

ipv4Bandwidth
boolean
否

是否开通IPv4公网带宽,默认开通IPv4公网带宽。

ipv6Bandwidth
boolean
否

是否开通IPv6带宽,默认不开通IPv6带宽。

bindPublicIp
ServerBindPublicIpReq
否

绑定已有公网IP信息(不可与publicIp参数同时填写,因暂不支持同时订购新的公网IP与绑定已有公网IP,且quantity取值只能为1)。

address
string
是

公网IP地址,请参考:查询公网IP列表(含带宽信息)。

floatingIpResourceId
string
否

公网IP的ID,请参考:查询公网IP列表(含带宽信息)。

securityGroupIds
<string> array
否

安全组ID。
说明:
1. 若不填写安全组,默认没有安全组。
2. 如果指定网卡ID(即networks.portId不为空),此参数无效。

name
string
否

云主机名,名称为5~59个字符,可包含英文、数字、'-','-'不可在名称开头或末尾。
1.若name为空,则随机生成主机名。
2.自动排序命名: 批量购买时自动加上三位数字的后缀,如:输入ECS-test,则命名为ECS-test-001、ECS-test-002。
3.自定义规则命名: 按照name_prefix[begin_number,bits]name_suffix格式给实例命名,name_prefix为名称前缀,name_suffix为名称后缀,[begin_number,bits]定义名称中间的数字部分,其中begin_number的取值范围为[1,999],bits的取值范围为[1,3],'['、']'、','均为英文字符。如:实例名称输入ECS[88,3]vm,则批量购买2台的实例名称依次为ECS-088-vm、ECS-089-vm。

password
string
否

云主机密码(采用RSA对明文加密,公钥内容详见接口说明,用户可用该公钥自行加密明文得到密文。明文8-16位字符,同时包括数字、大小写字母和特殊字符,其中不能出现3个及以上连续或重复的数字以及特殊字符最多不能超过3个,且需要在“~ @ # $ % * _ - + = , . ? [ ] { }”范围内;password和keypairName仅能填写一个);
不建议使用包含姓名、电话、出生日期、账号名、系统名以及公司名的密码;
不建议使用包含连续的字母、键位或重复的字母、字符的密码,比如abc、asd、@#$、AAA、###等。

keypairName
string
否

密钥对名称,可通过查询密钥列表接口获取。(password和keypairName仅能填写一个)。

userData
string
否

自定义参数,长度在[1,16384]个字符间。

description
string
否

主机描述,可输入[0,100]个字符。

dryRun
boolean
否

资源订购预检参数。

true:发送检查请求,不会订购资源。如果检查不通过,则返回对应错误。如果检查通过,则返回预检通过。

false(默认):发送正常请求,通过检查后直接订购资源。

请求示例

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/orderServer
{
	"region":"region",
	"billingType":"HOUR",
	"specsName":"s1.large.2",
	"bootVolume":{
		"size":40,
		"volumeType":"highPerformance"
	},
	"imageId":"9d652618-58a6-****",
	"networks":{
		"networkId":"d73fe71f-6753-4a0a-****"
	},
	"name":"test-api-1",
	"password":"srzE9jsTwO0mo4EAhipn2gS1fZ9W/5Boi3fb0JME1j3gdFSKZ9u5pPCifzb/9mXQdpnasy/JKV70h5m7fSnLYtF33CMw0n9kqONNlIELUBurfoI9Wtyf0eKFmnDAxqV8UO4T2/BdO1WeF4Um9d9fyBe1OqFCczl15Jfaj9/GI9c=",
	"quantity":1,
	"duration":0,
	"tags":[
		{
			"key":"key1",
			"value":"value1"
		}
	]
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
ServerApiCreateOrderResp

请求成功时返回的数据。

orderExtTypes
<enum(vm,performanceOptimization,highPerformance,performanceOptimizationyc,performanceOptimizationZX,highPerformanceyc,capacity,extremePerformanceL1,extremePerformanceL1yc,capebs,capebszx,ssdebs,ssd,capebsyc,ssdebsyc,ssdyc,bandwidth,ip,ipv6bandwidth,ironic,essdl1,essdycl1,essdl2,essdl3,edgessdebs,ecd)> array

订单项类型。

orderExts
<string> array

订单项ID。

orderId
string

订单ID。

paymentInfo
PaymentInfo

支付信息。

ActivityCode
string

交易代码。

BusiType
string

业务类型。

BusinessChannels
string

移动云全网渠道编码。

CerID
string

证书标识串。

ChargeMoney
string

充值金额。

CustomParam
string

商户自定义参数。

CustomerNumber
string

客户编码。

HomeProv
string

归属省份。

IDType
string

中国移动用户标识类型。

IDValue
string

中国移动用户号码。

NotifyURL
string

订单结果通知URL。

OrderMoney
string

订单总金额。

OrderNo
string

订单号。

Payment
string

用户支付金额。

ProductDesc
string

产品描述。

ProductID
string

产品编号。

ProductName
string

产品名称。

ProductURL
string

商品展示网址。

ReqChannel
string

请求方渠道编码。

ReturnURL
string

支付成功跳转返回页面URL。

SignValue
string

签名值。

TimeoutExpress
string

该笔订单允许的最晚付款时间。

WeiXinAppId
string

微信公众号ID/应用ID。

payLink
string

支付链接,paymentInfo节点下的所有以大写字母开头的参数,即序号为5.3~5.24的参数,用post+form表单的形式跳转到此链接。

procedureCode
enum(PREPAID,INTERNALAPPROVAL,POSTPAID)

付费类型。

resourceRemind
string

资源波动提示。

serverInstanceIds
<string> array

主机实例ID集合。注意:仅北京资源池且指定用户开放。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"requestId":"reqId-e5001ca1-***-bc6bebafe8c2",
	"state":"OK",
	"body":{
		"procedureCode":"POSTPAID",
		"orderId":"MOP-O-250205***34",
		"orderExts":[
			"MOP-T-250205***64",
			"MOP-T-250205***62"
		],
		"orderExtTypes":[
			"vm",
			"highPerformance"
		],
		"paymentInfo":null,
		"resourceRemind":null
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。