接口功能介绍
使用已创建成功的云主机备份,去申请新的云主机。新云主机的规格、镜像、数据盘、系统盘及数据等均与备份一致。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
计费模式:确认备份申请云主机的计费模式,详细查看计费模式
网络规划:规划云主机的网络环境,详细查看弹性云主机-网络
注意事项
成本估算:了解云主机的计费项
用户配额:确认个人在不同资源池下资源配额,可以通过用户配额查询接口进行查询
异步接口:该接口为异步接口,下单过后会拿到主订单ID(masterOrderID),后续可以调用根据订单号查询uuid,使用主订单ID来对订单情况与开通成功后的资源ID进行查询
企业项目:保证资源隔离,需确保所有资源与云主机处于相同企业项目下才可进行挂载操作,如网络资源:VPC、安全组、弹性IP、子网
标签绑定:云主机绑定标签时,标签键和值存在的情况下,绑定对应标签;不存在的情况下,创建新的标签并绑定云主机。主机创建完成后,云主机变为运行状态,此时标签仍可能未绑定,需等待一段时间(0~10分钟)。新的云主机不会绑定备份对应的云主机上的标签,如需标签请重新添加。
监控安装:在云服务器创建成功后,3-5分钟内将完成详细监控Agent安装,即开启云服务器CPU,内存,网络,磁盘,进程等指标详细监控,若不开启,则无任何监控数据。
代金券:只支持预付费用户抵扣包周期资源的金额,且不可超过包周期资源的金额
接口约束
1. 使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2. 至少存在一个备份
3. 备份的状态为可用
4. 目前不支持预付费账户创建按需付费类型云主机
5. 计费模式选择包年包月计费方式时,需要填写订购周期类型与订购时长
6. 自动分配弹性IP(extIP="1")时,需要填写弹性IP版本(ipVersion)与带宽大小(bandwidth);使用已有的弹性IP(extIP="2")时,需要填写弹性IP的版本(ipVersion),和对应弹性IP的ID(eipID或ipv6AddressID)
7. 挂载网卡时,子网与虚拟私有云存在对应关系,确保子网是虚拟私有云下的IP地址块
8. 云主机绑定多个标签时,标签键(参数labelKey)不可重复,单台云主机最多可绑定10个标签
URI
POST /v4/ecs/backup/create-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
regionID | 是 | String | 资源池ID,请输入备份所在的资源池,保证备份创建的云主机与备份在同一资源池。 | bb9fdb42056f11eda1610242ac110002 | |
azName | 否 | String | 可用区名称,不填写时默认使用备份所在可用区。您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区)。 | ||
instanceName | 是 | String | 云主机名称。不同操作系统下,云主机名称规则有差异。 Windows:长度为2~15个字符,允许使用大小写字母、数字或连字符(-)。不能以连字符(-)开头或结尾,不能连续使用连字符(-),也不能仅使用数字; 其他操作系统:长度为2-64字符,允许使用点(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,也不能仅使用数字 |
ecm-3300 | |
displayName | 是 | String | 云主机显示名称,长度为2-63字符 | ecm-3300 | |
instanceBackupID | 是 | String | 云主机备份ID,您可以查看产品定义-云主机备份来了解云主机备份 获取: 查 查询云主机备份列表 创 创建云主机备份 |
b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
flavorID | 是 | String | 云主机规格ID,您可以查看规格说明了解弹性云主机的选型基本信息 获取: 查 查询一个或多个云主机规格资源 注:同一规格名称在不同资源池不同可用区的规格ID是不同的,调用前需确认规格ID是否归属当前资源池,多可用区资源池确认是否归属当前可用区 |
0824679a-dc86-47dc-a0d3-9c330928f4f6 | |
vpcID | 是 | String | 虚拟私有云ID,您可以查看产品定义-虚拟私有云来了解虚拟私有云 获取: 查 查询VPC列表 创 创建VPC |
4797e8a1-722d-4996-9362-458001813e41 | |
onDemand | 是 | Boolean | 购买方式,取值范围: false(按周期), true(按需) 您可以查看计费模式了解云主机的计费模式 注:按周期(false)创建云主机需要同时指定cycleCount和cycleType参数 |
false | |
secGroupList | 否 | Array of Strings | 安全组ID列表,您可以查看安全组概述了解安全组相关信息 获取: 查 查询用户安全组列表 创 创建安全组 |
["sg-ulk99r4wja"] | |
networkCardList | 是 | Array of Objects | 网卡信息列表,您可以查看弹性网卡概述了解弹性网卡相关信息 | networkCardList | |
extIP | 是 | String | 是否使用弹性公网IP,取值范围: 0(不使用), 1(自动分配), 2(使用已有)。 注:自动分配弹性公网,默认分配IPv4弹性公网,需填写带宽大小,如需ipv6请填写弹性IP版本(即参数extIP="1"时,需填写参数bandwidth、ipVersion,ipVersion含默认值ipv4); 使用已有弹性公网,请填写弹性公网IP的ID,默认为ipv4版本,如使用已有ipv6,请填写弹性ip版本(即参数extIP="2"时,需填写eipID或ipv6AddressID,同时ipv6情况下请填写ipVersion) |
2 | |
ipVersion | 否 | String | 弹性IP版本,取值范围: ipv4(v4地址), ipv6(v6地址), 不指定默认为ipv4。注:请先确认该资源池是否支持ipv6 |
ipv4 | |
bandwidth | 否 | Integer | 带宽大小,单位为Mbit/s,取值范围:[1, 2000] | 100 | |
ipv6AddressID | 否 | String | ipv6地址的ID(多可用区类资源池暂不支持) | ddabc7f0-2121-4121-bf85-ec090b3a73fc | |
eipID | 否 | String | 弹性公网IP的ID,您可以查看产品定义-弹性IP]来了解弹性公网IP 获取: 查 查询指定地域已创建的弹性 IP 创 创建弹性 IP |
eip-9jpeyl0frh | |
affinityGroupID | 否 | String | 云主机组ID,获取: 查 查询云主机组列表或者详情 查 查询云主机组列表或详情(旧版) 创 创建云主机组 创 创建云主机组(旧版) |
924b95c4-68d9-3fbe-835d-fee46397feda | |
keyPairID | 否 | String | 密钥对ID,您可以查看密钥对来了解密钥对相关内容 获取: 查 查询一个或多个密钥对 查 查询一个或多个SSH密钥对(旧版) 创 创建一对SSH密钥对 创 创建一对SSH密钥对(旧版) |
c57d0626-8a82-407b-a910-b454907778c3 | |
userPassword | 否 | String | 用户密码,满足以下规则: 长度在8~30个字符; 必须包含大写字母、小写字母、数字以及特殊符号中的三项; 特殊符号可选:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/\且不能以斜线号 / 开头; 不能包含3个及以上连续字符; Linux镜像不能包含镜像用户名(root)、用户名的倒序(toor)、用户名大小写变化(如RoOt、rOot等); Windows镜像不能包含镜像用户名(Administrator)、用户名大小写变化(adminiSTrator等) |
HelloCtyun.13 | |
cycleCount | 否 | Integer | 订购时长,该参数需要与cycleType一同使用 注:最长订购周期为60个月(5年);cycleType与cycleCount一起填写 |
6 | |
cycleType | 否 | String | 订购周期类型,取值范围: MONTH:按月, YEAR:按年。注:cycleType与cycleCount一起填写 |
MONTH | |
autoRenewStatus | 否 | Integer | 是否自动续订,取值范围: 0(不续费), 1(自动续费), 注:按月购买,自动续订周期为1个月;按年购买,自动续订周期为1年 |
1 | |
userData | 否 | String | 用户自定义数据,需要以Base64方式编码,Base64编码后的长度限制为1-16384字符 | ZWNobyBoZWxsbyBnb3N0YWNrIQ== | |
projectID | 否 | String | 企业项目ID,企业项目管理服务提供统一的云资源按企业项目管理,以及企业项目内的资源管理,成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注:默认值为"0" |
0 | |
payVoucherPrice | 否 | Float | 代金券,满足以下规则:两位小数,不足两位自动补0,超过两位小数无效;不可为负数;字段为0时表示不使用代金券,默认不使用代金券。 | 20.55 | |
labelList | 否 | Array of Objects | 标签信息列表,注:单台云主机最多可绑定10个标签;主机创建完成后,云主机变为运行状态,此时标签仍可能未绑定,需等待一段时间(0~10分钟)。 | labelList | |
monitorService | 否 | Boolean | 监控参数,支持通过该参数指定云主机在创建后是否开启详细监控,取值范围: false(不开启), true(开启) 若指定该参数为true或不指定该参数,云主机内默认开启最新详细监控服务。 若指定该参数为false,默认不开启最新监控服务,而使用与原备份里保留的监控服务。 说明:仅部分资源池支持monitorService参数,详细请参考监控Agent概览。 |
true |
表 networkCardList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nicName | 否 | String | 长度2~32,支持拉丁字母、中文、数字、下划线、连字符,中文或英文字母开头,不能以http:或https:开头 | nic-0701 | |
fixedIP | 否 | String | 内网IPv4地址 | 192.168.0.2 | |
isMaster | 是 | Boolean | 是否主网卡,取值范围: true:主网卡, false:非主网卡 |
true | |
subnetID | 是 | String | 子网ID | a90eebf0-d798-5017-b9f0-9468bb2301c2 |
表 labelList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
labelKey | 是 | String | 标签键,长度限制1~32字符,注:同一台云主机绑定多个标签时,标签键不可重复 | test-key | |
labelValue | 是 | String | 标签值,长度限制1~32字符 | test-value |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误信息 | SUCCESS | |
description | String | 失败时的错误描述 | 成功 | |
returnObj | Object | 成功时返回的数据,参见表returnObj | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
masterResourceID | String | 主资源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:云主机的备份副本创建一台包年包月云主机,云主机所在的资源池为华东1可用区1,计费方式为包年包月,购买时长六个月,到期自动续订三个月
新创建云主机使用的规格、镜像、系统盘和数据盘与备份副本中的信息保持一致,备份副本中的镜像为:CTyunOS 2.0.1 64位,规格为:s7.small.1,
40 GiB SATA云系统盘,挂载20 GiB SATA云数据盘,公网出带宽为10 Mbit/s,自动分配公网IPv4地址,绑定主网卡,自动分配内网IPv4地址,
加入Default-Security-Group安全组,使用强制反亲和云主机组,使用代金券20.55支付金额,实例名称为apiCreate-test,登录密码为HelloCtyun.13,
数量一台,加入默认企业项目,增加一组标签。
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceBackupID":"ecd49382-8280-4d1a-8d87-2a4c004ee78d",
"instanceName": "apiCreate-test",
"displayName": "apiNew-06",
"vpcID": "vpc-ttxdh00rjf",
"secGroupList":["sg-ulk99r4wja"],
"affinityGroupID":"924b95c4-68d9-3fbe-835d-fee46397feda",
"networkCardList": [{
"subnetID": "subnet-ty87lkna06",
"isMaster": true
}],
"extIP": "1",
"bandwidth":10,
"ipVersion":"ipv4",
"onDemand": false,
"cycleCount": 6,
"cycleType": "MONTH",
"userPassword":"HelloCtyun.13",
"clientToken": "createTest1301",
"payVoucherPrice": 20.55,
"autoRenewStatus": 1,
"labelList": [{
"labelKey": "test-label",
"labelValue": "test-value"
}]
}
响应示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码