更新时间:2025-07-21 GMT+08:00
分享

查询单个快照信息

功能介绍

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

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/snapshots/{snapshot_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

snapshot_id

String

参数解释

快照ID。

可通过EVS控制台的云硬盘快照列表页面获取云硬盘快照ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

snapshot

SnapshotDetailV5 object

表4 SnapshotDetailV5

参数

参数类型

描述

id

String

参数解释

云硬盘快照ID。

取值范围

不涉及。

name

String

参数解释

云硬盘快照名称。

名称以autobk_snapshot_为前缀的快照是创建云硬盘备份时系统自动创建的,请不要进行“删除云硬盘快照”和“回滚快照到云硬盘”操作。

取值范围

不涉及。

description

String

参数解释

云硬盘快照描述信息。

取值范围

不涉及。

created_at

String

参数解释

云硬盘快照创建时间。

时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

取值范围

不涉及。

updated_at

String

参数解释

云硬盘快照更新时间。

取值范围

不涉及。

volume_id

String

参数解释

快照所属的云硬盘ID。

取值范围

不涉及。

size

String

参数解释

云硬盘快照大小,单位为GiB。

取值范围

不涉及。

status

String

参数解释

云硬盘快照的状态。

取值范围

具体请参见云硬盘快照状态

project_id

String

参数解释

项目ID。

取值范围

不涉及。

enterprise_project_id

String

参数解释

快照所属的企业项目ID。

取值范围

不涉及。

encrypted

Boolean

参数解释

是否为加密快照。

取值范围

不涉及。

cmk_id

String

参数解释

快照所属的云硬盘ID的密钥ID。

取值范围

不涉及。

category

String

参数解释

快照类型。

取值范围

枚举值:standard/flash。

availability_zone

String

参数解释

快照所属AZ。

取值范围

不涉及。

tags

Map<String,String>

参数解释

快照所属标签。

取值范围

不涉及。

instant_access

Boolean

参数解释

是否开启了快照极速可用功能。

取值范围

true:开启。仅SSD系列云盘支持开启该功能。

false:关闭。即快照为未开启快照极速可用功能的存量快照。

retention_at

String

参数解释

快照保留的时间。

取值范围

不涉及。

instant_access_retention_at

String

参数解释

设置快照极速可用功能的保留时间,保留时间到期后自动关闭快照极速可用功能。

取值范围

默认与参数retention_at的值一致。

incremental

Boolean

参数解释

是否增量快照。

取值范围

true,false。

snapshot_type

String

参数解释

快照创建来源。

取值范围

auto:自动创建快照。

user:手动创建快照。

copy:复制快照。

progress

String

参数解释

快照创建进度,单位为百分比。

取值范围

不涉及。

encrypt_algorithm

String

参数解释

加密快照的加密算法。

取值范围

不涉及。

snapshot_chains

Array of SnapshotChains objects

参数解释

快照所属的快照链信息。

取值范围

不涉及。

snapshot_group_id

String

参数解释

快照所属的一致性快照组id。

取值范围

不涉及。

表5 SnapshotChains

参数

参数类型

描述

id

String

参数解释

快照链ID。

取值范围

不涉及。

availability_zone

String

参数解释

快照链所属云硬盘的可用区。

取值范围

不涉及。

snapshot_count

Integer

参数解释

快照链上的快照个数。

取值范围

大于等于0。

capacity

Integer

参数解释

快照链的大小。

取值范围

大于等于0。

project_id

String

参数解释

项目ID。

取值范围

不涉及。

volume_id

String

参数解释

快照链所属的云硬盘ID。

取值范围

不涉及。

category

String

参数解释

快照链的类型。

取值范围

不涉及。

created_at

String

参数解释

创建时间。

取值范围

不涉及。

updated_at

String

参数解释

更新时间。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error

Error object

参数解释

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

取值范围

不涉及。

表7 Error

参数

参数类型

描述

code

String

参数解释

出现错误时,返回的错误码。

取值范围

错误码和其对应的含义请参考错误码说明

message

String

参数解释

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

取值范围

不涉及。

请求示例

GET https://{endpoint}/v5/{project_id}/snapshots/{snapshot_id}

响应示例

状态码:200

OK

{
  "snapshot" : {
    "id" : "308c213b-5e09-478e-a772-c81b20749fea",
    "status" : "available",
    "project_id" : "7c08fb7726964bf5b70a1f55a4cd6017",
    "size" : 1,
    "name" : null,
    "description" : null,
    "cmk_id" : null,
    "encrypted" : false,
    "created_at" : "2023-07-03T08:53:13.373010",
    "updated_at" : "2023-07-03T08:53:13.578010",
    "volume_id" : "66016b8d-b850-4afb-b2a4-d5903e9ffb59",
    "enterprise_project_id" : "0",
    "category" : "flash",
    "availability_zone" : "az2.dc2",
    "tags" : { },
    "instant_access" : true,
    "instant_access_retention_at" : "2023-07-07T08:53:13.373010",
    "retention_at" : "2023-07-07T08:53:13.373010"
  }
}

状态码:400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档