快照创建一台云主机
接口功能介绍
使用已创建成功的云主机快照,去申请新的云主机。新云主机的规格、镜像、数据盘、系统盘及数据等均与快照一致。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
计费模式:确认开通云主机的计费模式,详细查看计费模式
注意事项:
成本估算:了解云主机的计费项
标签绑定:云主机绑定标签时,标签键和值存在的情况下,绑定对应标签;不存在的情况下,创建新的标签并绑定云主机。主机创建完成后,云主机变为运行状态,此时标签仍可能未绑定,需等待一段时间(0~10分钟)。新的云主机不会绑定快照对应的云主机上的标签,如需标签请重新添加。
接口约束
1.至少存在一个快照
2.快照的状态为可用
3.快照原本的云主机存在
4. 云主机绑定多个标签时,标签键(参数labelKey)不可重复,单台云主机最多可绑定10个标签
URI
POST /v4/ecs/snapshot/create-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
projectID | 否 | String | 企业项目ID,企业项目管理服务提供统一的云资源按企业项目管理,以及企业项目内的资源管理,成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注:默认值为"0" |
aaaaaaaa-bda4-4102-b68f-98c9d7190d69 | |
instanceName | 是 | String | 云主机名称,不可以使用已存在的云主机名称。不同操作系统下,云主机名称规则有差异。 Windows:长度为2~15个字符,允许使用大小写字母、数字或连字符(-)。不能以连字符(-)开头或结尾,不能连续使用连字符(-),也不能仅使用数字; 其他操作系统:长度为2-64字符,允许使用点(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,也不能仅使用数字 |
ecm-3300 | |
displayName | 是 | String | 云主机显示名称,长度为2-63字符 | ecm-3300 | |
snapshotID | 是 | String | 云主机快照ID, 获取: 查 查询云主机快照列表 创 创建云主机快照 |
f02bef68-7aba-f51d-6ead-7d47dde57b45 | |
vpcID | 是 | String | 虚拟私有云ID,您可以查看产品定义-虚拟私有云来了解虚拟私有云 获取: 查 查询VPC列表 创 创建VPC 注:在多可用区类型资源池下,vpcID通常以“vpc-”开头,非多可用区类型资源池vpcID为uuid格式 |
4797e8a1-722d-4996-9362-458001813e41 | |
onDemand | 是 | Boolean | 购买方式,取值范围: false(按周期), true(按需) 您可以查看计费模式了解云主机的计费模式 注:按周期(false)创建云主机需要同时指定cycleCount和cycleType参数 |
false | |
secGroupList | 否 | Array of Strings | 安全组ID列表,您可以查看安全组概述了解安全组相关信息 获取: 查 查询用户安全组列表 创 创建安全组 注:在多可用区类型资源池下,安全组ID通常以“sg-”开头,非多可用区类型资源池安全组ID为uuid格式 |
["202ca2d2-273a-5995-873b-03731212c8e4"] | |
networkCardList | 是 | Array of Objects | 网卡信息列表,您可以查看弹性网卡概述了解弹性网卡相关信息 | networkCards | |
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] 注:extIP取值1时,bandWidth生效且必填 |
100 | |
ipv6AddressID | 否 | String | 弹性公网IPv6的ID(多可用区类资源池暂不支持) | ||
eipID | 否 | String | 弹性公网IP的ID | eip-9jpeyl0frh | |
affinityGroupID | 否 | String | 云主机组ID,获取: 查 查询云主机组列表或者详情 查 查询云主机组列表或详情 创 创建云主机组 |
259b0c37-1044-41d8-989e | |
keyPairID | 否 | String | 密钥对ID,您可以查看密钥对来了解密钥对相关内容 获取: 查 查询一个或多个密钥对 创 创建一对SSH密钥对 |
c57d0626-8a82-407b-a910-b454907778c3 | |
userPassword | 否 | String | 用户密码,满足以下规则: 长度在8~30个字符; 必须包含大写字母、小写字母、数字以及特殊符号中的三项; 特殊符号可选:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/\且不能以斜线号 / 开头; 不能包含3个及以上连续字符; Linux镜像不能包含镜像用户名(root)、用户名的倒序(toor)、用户名大小写变化(如RoOt、rOot等); Windows镜像不能包含镜像用户名(Administrator)、用户名大小写变化(adminiSTrator等) |
||
cycleCount | 否 | Integer | 订购时长,该参数需要与cycleType一同使用 注:最长订购周期为60个月(5年);cycleType与cycleCount一起填写 |
6 | |
cycleType | 否 | String | 订购周期类型,取值范围: MONTH:按月 YEAR:按年 最长订购周期为5年 |
MONTH | |
autoRenewStatus | 否 | Integer | 是否自动续订,取值范围: 0(不续费), 1(自动续费), 注:按月购买,自动续订周期为3个月;按年购买,自动续订周期为1年 |
1 | |
userData | 否 | String | 用户自定义数据,需要以Base64方式编码,需要以Base64方式编码,Base64编码后的长度限制为1-16384字符 | ZWNobyBoZWxsbyBnb3N0YWNrIQ== | |
labelList | 否 | Array of Objects | 标签信息列表,注:单台云主机最多可绑定10个标签;主机创建完成后,云主机变为运行状态,此时标签仍可能未绑定,需等待一段时间(0~10分钟)。 | labelList | |
monitorService | 否 | Boolean | 监控参数,支持通过该参数指定云主机在创建后是否开启详细监控,取值范围: false(不开启), true(开启) 若指定该参数为true或不指定该参数,云主机内默认开启最新详细监控服务。 若指定该参数为false,默认不开启最新监控服务,而使用与原快照里保留的监控服务。 说明:仅部分资源池支持monitorService参数,详细请参考监控Agent概览。 |
true |
表 networkCardList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nicName | 否 | String | 长度2~32,支持拉丁字母、中文、数字、下划线、连字符,中文或英文字母开头,不能以http:或https:开头 | ||
fixedIP | 否 | String | 内网IPv4地址 | ||
isMaster | 是 | Boolean | 是否主网卡,取值范围: true表示主网卡, 表示扩展网卡 |
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
masterResourceID | String | 主资源ID | 3cda4bf48cac42b8b7db3b279d2fc6fb | |
regionID | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 |
请求示例
请求头header
无
请求体body
示例:在华东1资源池使用云主机的快照创建一台云主机,实例名称为"sp-createvm-01",计费方式为包年包月,购买时长一个月,创建云主机使用的规格、镜像、系统盘和数据盘与快照中的信息保持一致,绑定一组标签
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"clientToken": "spcreatevm01",
"instanceName": "sp-createvm-01",
"displayName": "sp-createvm-01",
"snapshotID": "e0d3d36d-fbeb-9cdc-2e1b-c96a2fec53cd",
"vpcID": "vpc-4j28inmqzo",
"onDemand": false,
"cycleType": "MONTH",
"cycleCount": 1,
"networkCardList": [{
"subnetID": "subnet-jpfervn9i3",
"isMaster": true
}],
"extIP": "0",
"labelList": [{
"labelKey": "test-label",
"labelValue": "test-value"
}]
}
响应示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterResourceID": "34c7cc05a52b48eda0a84e34a82b346b",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.Instance.ParameterInvalid | 请求参数错误 |
Ecs.Instance.NameRepeat | 云主机名称不可重复 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.CustomerAdmin.AccessFailed | 查询用户信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.CustomerAdmin.FormatError | 查询用户信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.CustomerCheck.UnknownError | 查询用户信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserQuota.DataDamaged | 查询用户配额信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserQuota.AccessFailed | 查询用户配额信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.UserQuota.Empty | 查询用户配额信息为空,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionAdmin.AccessFailed | 查询用户许可信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionAdmin.FormatError | 查询用户资源池许可信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PermissionCheck.UnknowError | 查询用户许可信息失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.ResourcesWorkorder.AccessFailed | 查询用户已有资源错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.ResourcesCheck.UnknownError | 查询用户已有资源失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.ResourcesFormat.FormatError | 查询用户已有资源格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.SnapshotWorkorder.AccessFailed | 查询快照信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Snapshot.InfoNotFound | 未查询到云主机快照信息,请确认云主机快照是否存在 |
Ecs.Snapshot.StatusNotValid | 快照状态无效:请确认快照是否处于可用状态. |
Ecs.Snapshot.SysDiskNotFound | 未查询到快照的云主机系统盘信息,请检查系统盘是否存在 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.EcsFormat.FormatError | 查询云主机信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.NotFound | 云主机不存在,请确认云主机ID是否有效 |
Openapi.EcsCheck.UnknownError | 云主机检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Snapshot.ImageNotFound | 快照所用镜像不存在,请检查镜像信息是否有效 |
Image.ImageFormat.FormatError | 查询镜像信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Image.ImageAdmin.AccessFailed | 查询镜像信息错误,请重试。如果多次尝试失败,请提交工单 |
Image.ImageWorkorder.AccessFailed | 查询镜像信息错误,请重试。如果多次尝试失败,请提交工单 |
Image.ImageCheck.NotFound | 镜像不存在或不符合要求,请确认镜像信息是否正确 |
Image.ImageCheck.UnknownError | 查询镜像信息失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Snapshot.FlavorNotFound | 快照所用规格不存在,请检查规格信息是否有效 |
Openapi.FlavorCheck.UnknownError | 云主机规格检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.FlavorAdmin.AccessFailed | 查询云主机规格失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.FlavorAdmin.FormatError | 查询云主机规格信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.EbsInfo.AccessFailed | 查询云硬盘信息失败 |
Ecs.EbsInfo.DataDamaged | 云硬盘信息数据不符预期 |
Ecs.Snapshot.EbsNotFound | 快照所用数据盘不存在,请检查磁盘信息是否有效 |
Ecs.Instance.NameNotValid | 云主机名称无效 |
Openapi.QuotaCheck.QuotaExceed | 用户限额信息超出系统限额 |
Openapi.QuotaCheck.UnknownError | 配额检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.IAM.ActionError | 用户权限失败,请检查是否有该api权限 |
Ecs.OrderCheck.InvalidProjectID | 企业项目不存在,请确认企业项目ID是否有效 |
Ecs.Parameter.InvalidCycleCount | 请求参数错误: [cycleCount]参数错误,请重新输入 |
Ecs.Parameter.InvalidCycleType | 请求参数错误: [cycleType]参数错误,请重新输入 |
Ecs.OrderCheck.UserForbiddenOnDemand | 用户不允许订购按需类订单,请确认用户是否有该操作权限 |
Openapi.VpcWorkorder.AccessFailed | 查询VPC信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.VpcFormat.FormatError | 查询VPC信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.VpcCheck.NotFound | 未找到对应的VPC信息,请确认输入的VPC信息是否有效 |
Ecs.Instance.NetcardInvalid | 必须且只能配置一个主网卡,请确认输入的主网卡信息是否有效 |
Ecs.Instance.VpcNoPermission | 用户无该VPC所属企业项目权限,请确认输入的VPC信息是否有效 |
Openapi.SubnetCheck.NotFound | 未找到对应的子网信息,请确认输入的子网信息是否有效 |
Ecs.Instance.FixedIPRepeat | 内网ip不可重复,请确认输入的内网IP是否有效 |
Openapi.SubnetWorkorder.AccessFailed | 查询vpc ip信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.SubnetFormat.FormatError | 查询vpc ip信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Ecs.FixedIP.NotValid | 内网ip地址已被使用或不属于所选子网网段 |
Ecs.Instance.PublicIpInvalid | 自动分配公网ip需要指定带宽,请确认输入的信息是否有效 |
Ecs.Instance.PublicIpInvalid | 自动分配公网ip不支持指定ip地址,请确认输入的信息是否有效 |
Ecs.Instance.PublicIpInvalid | 使用已有IP需要指定IP资源的Id,请确认输入的信息是否有效 |
Openapi.VpcCheck.UnknownError | vpc检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.PublicIpWorkorder.AccessFailed | 查询公网ip信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.PublicIpCheck.NotFound | 未找到对应的公网ip地址,请确认输入的ip信息是否有效 |
Openapi.PublicIpFormat.FormatError | 查询公网ip信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.KeypairWorkorder.AccessFailed | 查询密钥对信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.KeypairFormat.FormatError | 查询密钥对信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.KeypairCheck.NotFound | 未找到对应的密钥对,请确认输入的密钥对信息是否有效 |
Openapi.KeypairCheck.UnknownError | 密钥对检查失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.VmgroupWorkorder.AccessFailed | 查询云主机组信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.VmgroupFormat.FormatError | 查询云主机组信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.VmgroupCheck.NotFound | 未找到对应的云主机组,请确认输入的云主机组信息是否有效 |
Openapi.VmgroupCheck.UnknowError | 云主机组检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Instance.VmGroupNoPermission | 用户无该云主机组所属企业项目权限,请确认输入的云主机组是否有效 |
Ecs.AffinityGroupCheck.NoPermission | 云主机组无权限操作 |
Openapi.SecGroupsWorkorder.AccessFailed | 查询安全组信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.SecGroupsFormat.FormatError | 查询安全组信息格式错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.SecGroupsCheck.NotFound | 未找到对应的安全组,请确认输入的安全组组信息是否有效 |
Openapi.SecGroupsCheck.UnknowError | 安全组检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.SecGroups.NotFound | 未找到默认安全组,请指定安全组后重试 |
Ecs.Instance.SecurityGroupNoPermission | 用户无该安全组所属企业项目权限,请确认输入的安全组组是否有效 |
Openapi.SaleYacos.AccessFailed | 查询售罄信息错误,请重试。如果多次尝试失败,请提交工单 |
Openapi.SaleFormat.FormatError | 查询售罄信息格式错误,请重试。如果多次尝试失败,请提交工单 |
ECS.Instance.FlavorSoldOut | 该规格云主机已售罄,请提交工单 |
ECS.Instance.EbsSoldOut | 该规格磁盘已售罄,请提交工单 |
ECS.Instance.PublicIpSoldOut | 该公网ip已售罄,请提交工单 |
Ecs.LabelKey.Repeat | 标签键不可重复 |
Openapi.SaleCheck.UnknownError | 售罄信息检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Parameter.InvalidAutoRenewStatus | 请求参数错误:autoRenewStatus只支持0或1 |
Openapi.AutoRenew.UnknownError | 续订信息检查失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.Order.ProcFailed | 订单处理失败 |