更新时间:2025-08-20 GMT+08:00

创建快照

功能介绍

创建标准快照。标准快照当前只在部分区域支持,具体的区域列表请参见"功能总览"中快照页签下的区域信息。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/snapshots

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。

约束限制

不涉及。

取值范围

获取方法请参见"获取项目ID"。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

约束限制

不涉及。

取值范围

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

snapshot

CreateStandardSnapshot object

表4 CreateStandardSnapshot

参数

是否必选

参数类型

描述

volume_id

String

参数解释

云硬盘id。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

云硬盘快照名称。

约束限制

最大支持64个字符。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

云硬盘快照描述。

约束限制

最大支持85个字符。

取值范围

不涉及。

默认取值

不涉及。

tags

Map<String,String>

参数解释

云硬盘快照的标签。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

enterprise_project_id

String

参数解释

云硬盘快照的企业项目id。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instant_access

Boolean

参数解释

是否开启快速可用功能。

约束限制

不涉及。

取值范围

不涉及。

默认取值

默认为false,表示不开启。

incremental

Boolean

参数解释

是否创建增量快照。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:202

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

任务ID。

取值范围

不涉及。

snapshot_id

String

参数解释

快照ID。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

出现错误时,返回的错误信息。

取值范围

不涉及。

表7 Error

参数

参数类型

描述

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

错误码

请参见错误码