接口说明
该接口用于创建云主机启动模板。
URL
POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/orderTemplate
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
templateCreateReq
|
TemplateApiCreateReq
|
是
|
创建模板请求体。 |
|
description
|
string
|
否
|
描述。 |
|
name
|
string
|
是
|
模板名称。 |
|
template
|
TemplateApiValidateReq
|
是
|
模板参数详情。 |
|
autoRenew
|
boolean
|
否
|
是否自动续订。 |
|
region
|
string
|
是
|
可用区。您可以调用查询属地的可用区信息接口查看可用区信息。 示例值：BJJD。 |
|
billingType
|
enum(MONTH,YEAR,HOUR)
|
否
|
付费方式。YEAR：包年，MONTH：包月，HOUR：按量。 默认：HOUR。 |
|
duration
|
integer(int32)
|
否
|
订购时长(月/年)，按量付费填写0;包月后付费（政企集团或省集团客户）填写需要订购的时长，取值范围为[0,60]，如果取值为0，会设置成订购一个月并开启自动续订，1-60表示具体订购的月数;包月预付费（互联网客户）填写需要订购的时长，取值范围为[1,12]，1-12表示具体订购的月数;包年付费填写需要订购的年数，取值范围为[1,5];说明：该参数在按量或包月后付费默认为0。 |
|
specsName
|
string
|
是
|
规格名称，建议填写，如s1.medium.2。如填写该值，将以规格名称作为创建云主机规格的依据，可通过云主机帮助中心产品描述>规格，查看具体请参考：查看云主机可用区规格列表。 |
|
imageId
|
string
|
是
|
镜像ID。 |
|
bootVolume
|
云主机系统盘请求体
|
是
|
系统盘。 |
|
size
|
integer(int32)
|
否
|
系统盘大小(GB)，Linux系统盘大小为max{20, 镜像大小}，Windows系统盘最小为max{40, 镜像大小}，最大均为2048。 |
|
volumeType
|
enum(highPerformance,performanceOptimization,highPerformanceyc,performanceOptimizationyc)
|
是
|
系统盘类型,highPerformance:高性能型;highPerformanceyc:高性能型-云创;performanceOptimization:性能优化型;performanceOptimizationyc:性能优化型-云创。 |
|
dataVolume
|
<云主机数据盘请求体> array
|
否
|
一体化订购中数据盘产品。 |
|
isShare
|
boolean
|
否
|
是否为共享数据盘,默认为非共享盘。 |
|
size
|
integer(int32)
|
否
|
数据盘大小(G),大小需在[10,32768]间。 |
|
volumeType
|
enum(capebs,ssd,ssdebs,capebsyc,ssdyc,ssdebsyc)
|
是
|
数据盘类型,capebs:容量型数据盘;ssd:高性能型数据盘;ssdebs:性能优化型数据盘;capebsyc:容量型数据盘-云创;ssdyc:高性能型数据盘-云创;ssdebsyc:性能优化型数据盘-云创。 |
|
networks
|
云主机网络信息请求体
|
是
|
网络，如填写，networkId必填。 |
|
initialIp
|
string
|
否
|
指定IP地址。 |
|
networkId
|
string
|
是
|
指定网络ID。请参考查询VPC下网络对应返参中的id。 |
|
portId
|
string
|
否
|
指定网卡ID，具体可通过虚拟私有云（VPC）产品>虚拟网卡>查询虚拟网卡列表接口获取。 |
|
publicIp
|
云主机公网IP请求体
|
否
|
一体化订购公网IP产品。如需一体化订购公网IP产品，必须一起填写publicIp与bandwidth参数（不可与bindPublicIp参数同时填写，因暂不支持同时订购新的公网IP与绑定已有公网IP）。 |
|
ipType
|
enum(MOBILE,MULTI_LINE)
|
否
|
公网IP类型,MOBILE:弹性公网IP;MULTI_LINE:优享版弹性公网IP。 |
|
bandwidth
|
云主机带宽请求体
|
否
|
一体化订购中带宽产品。 |
|
bandwidthSize
|
integer(int32)
|
是
|
公网IP带宽大小 (Mbps)，取值范围为[1,500]。如需订购更大带宽，请通过工单申请订购权限。 |
|
chargeMode
|
enum(bandwidthCharge,trafficCharge)
|
是
|
公网IP带宽计费方式,bandwidthCharge:按带宽计费;trafficCharge:按流量计费。 |
|
ipv4Bandwidth
|
boolean
|
否
|
是否开通IPV4公网带宽，默认开通IPV4公网带宽。 |
|
ipv6Bandwidth
|
boolean
|
否
|
是否开通IPV6带宽，默认不开通IPV6带宽。 |
|
bindPublicIp
|
云主机绑定公网ip请求体
|
否
|
绑定已有公网IP信息（不可与publicIp参数同时填写，因暂不支持同时订购新的公网IP与绑定已有公网IP）, 如填写，address必填。 |
|
address
|
string
|
是
|
公网IP地址。 |
|
floatingIpResourceId
|
string
|
否
|
公网IP ID。 |
|
securityGroupIds
|
<string> array
|
是
|
安全组ID，如果指定网卡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]个字符。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/orderTemplate{
"body":{
"name":"templateTest",
"template":{
"region":"SZJD",
"billingType":"HOUR",
"specsName":"c3.2xlarge.4",
"imageId":"a7fe02ee-86e9-4520-8742-750c2acaa738",
"bootVolume":{
"size":40,
"volumeType":"highPerformance"
},
"networks":{
"networkId":"353bbb50-b5bb-4650-aae7-fa700c4eae52"
},
"securityGroupIds":[
"14d2cfbe-b664-4d6e-b439-6f7ee9a42347"
],
"name":"vmTest"
}
}
}返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
string
|
请求成功时返回的数据 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码;返回正常：OK,返回错误：ERROR,返回异常：EXCEPTION,需要告警实现的：ALARM,禁止访问：FORBIDDEN |
返回示例
{
"requestId":"reqId-74fa1fe47f775efb3fa38-7acc73c8-1",
"state":"OK",
"body":"ce58fbb23ea4414597786f2a52d6d423"
}