接口功能介绍
创建云主机快照
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
云主机快照的配额限制:单台云主机可创建的快照配额数量。确认个人在不同资源池下资源配额,可以通过用户配额查询接口进行查询
接口约束
1.云主机必须存在
2.云主机必须处于运行中(running)或关机(stopped)状态
3.云主机快照名称不能和已有云主机快照重名
4. 云主机所挂全部盘的状态需要为"已挂载"
5. 挂载了本地盘,共享盘,XSSD盘,ISCSI磁盘模式盘的云主机不支持快照功能
URI
POST /v4/ecs/snapshot/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
instanceID | 是 | String | 云主机ID,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
b6e2966d-7b1c-385e-abe4-d940caa273b7 | |
snapshotName | 是 | String | 云主机快照名称。满足以下规则:长度为2-63字符,头尾不支持输入空格 | test |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
jobID | String | 任务ID | 5f653b14-d602-4ea2-bae7-44a7d9c33a93 | |
snapshotStatus | String | 云主机快照状态, pending: 创建中, available: 可用, restoring: 恢复中, error:错误 |
pending | |
instanceID | String | 云主机ID | b275b936-9b8d-223e-586a-c5282d96c6a1 | |
instanceName | String | 云主机名称 | ecs | |
snapshotID | String | 云主机快照ID | 3eee1eb3-6117-2a1d-4d59-582ead37273b | |
projectID | String | 企业项目ID | 0 | |
snapshotName | String | 云主机快照名称 | test |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:在华东1资源池为一台云主机创建快照
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "b6e2966d-7b1c-385e-abe4-d940caa273b7",
"snapshotName": "test"
}
响应示例
{
"returnObj": {
"snapshotStatus": "pending",
"projectID": "0",
"instanceID": "b275b936-9b8d-223e-586a-c5282d96c6a1",
"snapshotName": "test",
"instanceName": "ecs",
"snapshotID": "3eee1eb3-6117-2a1d-4d59-582ead37273b",
"jobID": "7027d439-1583-4170-ba69-a54306163bb6"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码