创建云硬盘快照
功能介绍
创建云硬盘快照。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/snapshots
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方法请参见"获取项目ID"。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
snapshot |
是 |
CinderCreateSnapshotOption object |
待创建得快照信息 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
volume_id |
是 |
String |
创建快照源云硬盘的ID。 通过查询所有云硬盘详情获取。 |
description |
否 |
String |
云硬盘快照描述，可以为null。最大支持85个字符。 |
force |
否 |
Boolean |
强制创快照标示，默认为false。 当force标记为false时，云硬盘处于挂载状态时，不能强制创建快照。 当force标记为true时，即使云硬盘处于挂载状态时，仍可以创建快照 |
metadata |
否 |
Map<String,String> |
云硬盘快照的元数据信息。 |
name |
否 |
String |
云硬盘快照名称。最大支持64个字符。 说明：
对云硬盘创建备份时，同时会创建以autobk_snapshot_为名称前缀的快照， 云硬盘控制台对此类快照会有操作限制。因此建议不要创建以autobk_snapshot_为名称前缀的快照， 避免影响快照的正常使用。 |
响应参数
状态码： 202
参数 |
参数类型 |
描述 |
|---|---|---|
snapshot |
SnapshotSummary object |
快照信息。 |
参数 |
参数类型 |
描述 |
|---|---|---|
created_at |
String |
云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
description |
String |
云硬盘快照描述信息。 |
id |
String |
云硬盘快照ID。 |
metadata |
Map<String,String> |
云硬盘快照的元数据信息。 如果元数据中包含__system__enableActive字段，则表示该快照为云服务器创建备份时自动生成的快照。 |
name |
String |
云硬盘快照名称 |
size |
Integer |
云硬盘快照大小，单位为GiB。 |
status |
String |
云硬盘快照状态，具体请参见云硬盘快照状态。 |
updated_at |
String |
快照更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
volume_id |
String |
快照所属的云硬盘ID。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error |
Error object |
出现错误时，返回的错误信息。 |
请求示例
创建一个云硬盘快照，当源云硬盘处于挂载状态时，不能强制创建快照。
POST https://{endpoint}/v2/{project_id}/snapshots
{
"snapshot" : {
"name" : "snap-001",
"description" : "Daily backup",
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"force" : false,
"metadata" : { }
}
}
响应示例
状态码： 202
Accepted
{
"snapshot" : {
"status" : "creating",
"description" : "Daily backup",
"created_at" : "2013-02-25T03:56:53.081642",
"metadata" : { },
"volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"size" : 1,
"id" : "ffa9bc5e-1172-4021-acaf-cdcd78a9584d",
"name" : "snap-001",
"updated_at" : "2013-02-25T03:56:53.081642"
}
}
状态码： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
状态码
状态码 |
描述 |
|---|---|
202 |
Accepted |
400 |
Bad Request |
错误码
请参见错误码。
