创建快照一致性组
功能介绍
创建快照一致性组。标准快照当前只在部分区域支持，具体的区域列表请参见"功能总览"中快照页签下的区域信息。
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/snapshot-groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目ID。获取方法请参见获取项目ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
snapshot_group |
是 |
SnapshotGroup object |
参数解释 待创建快照一致性组的信息。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_id |
否 |
String |
参数解释 云服务器id。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
volume_ids |
否 |
Array of strings |
参数解释 云硬盘id列表。 约束限制 格式为ids=["id1","id2",...,"idx"]。 如果设置了server_id，则该参数只能设置指定实例内已挂载的云硬盘，不再支持设置多个跨实例的云硬盘ID。 取值范围 不涉及。 默认取值 不涉及。 |
|
instant_access |
否 |
Boolean |
参数解释 是否开启快照极速可用。 约束限制 不涉及。 取值范围
默认取值 false |
|
name |
否 |
String |
参数解释 快照一致性组名称。 约束限制 最大支持255个字节。 取值范围 最小长度：0 最大长度：255 默认取值 不涉及。 |
|
description |
否 |
String |
参数解释 快照一致性组描述。 约束限制 最大支持255个字节。 取值范围 最小长度：0 最大长度：255 默认取值 不涉及。 |
|
tags |
否 |
Map<String,String> |
参数解释 快照一致性组的标签。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
enterprise_project_id |
否 |
String |
参数解释 快照一致性组所属的企业项目ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
incremental |
否 |
Boolean |
参数解释 是否创建增量快照。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
响应参数
状态码：202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
参数解释 任务ID。
取值范围 不涉及。 |
|
snapshot_group_id |
String |
参数解释 快照一致性组ID。 取值范围 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
参数解释 出现错误时，返回的错误信息。 取值范围 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释 出现错误时，返回的错误码。 取值范围 错误码和其对应的含义请参考错误码说明。 |
|
message |
String |
参数解释 出现错误时，返回的错误消息。 取值范围 不涉及。 |
请求示例
POST https://{endpoint}/v5/{project_id}/snapshot-groups
{
"snapshot_group" : {
"server_id" : null,
"volume_ids" : [ "e1fa3e72-8c92-4871-9152-bf66fef0afe9" ],
"name" : "test_name",
"description" : "test_description",
"tags" : {
"this_is_test_key" : "this_is_test_value"
},
"enterprise_project_id" : "0"
}
}
响应示例
状态码：202
Accepted
{
"job_id" : "XXXXX",
"snapshot_group_id" : "XXXXXX"
}
状态码：400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "EVS.XXX"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
Accepted |
|
400 |
Bad Request |
错误码
请参见错误码。
