创建快照 - CreateSnapshotV5
功能介绍
创建标准快照。标准快照当前只在部分区域支持，具体的区域列表请通过控制台查询。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/snapshots
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目ID。获取方法请参见获取项目ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
snapshot |
是 |
CreateStandardSnapshot object |
参数解释 创建标准快照请求体。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
volume_id |
否 |
String |
参数解释 云硬盘id。 可通过查询所有云硬盘详情获取云硬盘ID。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
name |
否 |
String |
参数解释 云硬盘快照名称。 可通过查询云硬盘快照详情列表接口获取云硬盘快照名称。 约束限制 不涉及。 取值范围 最大支持64个字符。 默认取值 不涉及。 |
|
description |
否 |
String |
参数解释 云硬盘快照描述。 约束限制 不涉及。 取值范围 最大支持85个字符。 默认取值 不涉及。 |
|
tags |
否 |
Map<String,String> |
参数解释 云硬盘快照的标签。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
|
enterprise_project_id |
否 |
String |
参数解释 云硬盘快照的企业项目id。 关于企业项目ID的获取及企业项目特性的详细信息，请参考："企业管理用户指南"。 约束限制 不涉及。 取值范围 不涉及。 默认取值 0，表示default企业项目。 |
|
instant_access |
否 |
Boolean |
参数解释 是否开启极速可用功能。 约束限制 不涉及。 取值范围
默认取值 默认为false，表示不开启。 |
|
incremental |
否 |
Boolean |
参数解释 是否创建增量快照。 约束限制 不涉及。 取值范围
默认取值 true |
响应参数
状态码：202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
参数解释 任务ID。 如果需要查询job的状态，请参考："查询job的状态"。 取值范围 不涉及。 |
|
snapshot_id |
String |
参数解释 快照ID。 取值范围 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
参数解释 出现错误时，返回的错误信息。 取值范围 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释 出现错误时，返回的错误码。 取值范围 错误码和其对应的含义请参考错误码说明。 |
|
message |
String |
参数解释 出现错误时，返回的错误消息。 取值范围 不涉及。 |
请求示例
POST https://{endpoint}/v5/{project_id}/snapshots
{
"snapshot" : {
"volume_id" : "2c194dde-7de5-4529-a141-49f48181f411",
"name" : "test_name",
"description" : "test description",
"enterprise_project_id" : "94f1ea84-1428-49b6-9920-8a9b8a29e4ca"
}
}
响应示例
状态码：202
Accepted
{
"job_id" : "ee62a0c1e79c4e11be5adc17a49f69ef",
"snapshot_id" : "bb02c803-55ac-4e84-9c80-60d352199d7d"
}
状态码：400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "EVS.XXX"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
Accepted |
|
400 |
Bad Request |
错误码
请参见错误码。
