# 查询快照详情列表 - ListSnapshotsDetailsV5 #### 功能介绍 查询快照详情列表。标准快照当前只在部分区域支持，具体的区域列表请通过控制台查询。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-evs/evs_04_0009.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-evs/evs_04_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | evs:snapshots:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v5/{project_id}/snapshots/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释** 分页查询的起始资源id，取值为上一页最后一条查询记录的资源id。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | volume_id | 否 | String | **参数解释** 快照对应的云硬盘ID。 可通过[查询所有云硬盘详情](https://support.huaweicloud.com/api-evs/evs_04_2006.html)获取云硬盘ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | availability_zone | 否 | String | **参数解释** 快照对应的云硬盘所在的可用区。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | limit | 否 | String | **参数解释** 返回结果个数限制。 当租户所有的快照数量大于50个时，为了提升您的查询效率，建议查询的时候使用limit参数，并且参数值最大设置为50。查询示例： GET /v2/xxx/snapshots/detail?limit=50，表示查询第1\~50个快照。GET /v2/xxx/snapshots/detail?offset=50\&limit=50，表示查询第51\~100个快照。 **约束限制** 不涉及。 **取值范围** 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 **默认取值** 不涉及。 | | name | 否 | String | **参数解释** 快照名称。 **约束限制** 不涉及。 **取值范围** 最大支持255个字符。 **默认取值** 不涉及。 | | offset | 否 | String | **参数解释** 偏移量。 分页查询快照时使用，与limit配合使用。假如共有30个快照， 设置offset为11，limit为10，即为从第12个快照开始查询， 一次最多可读取10个快照。 **约束限制** 与limit配合使用。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | status | 否 | String | **参数解释** 快照状态。 **约束限制** 不涉及。 **取值范围** \[具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。\] **默认取值** 不涉及。 | | sort_key | 否 | String | **参数解释** 返回结果按该关键字排序。 **约束限制** 不涉及。 **取值范围** - id：云硬盘快照ID。 - status：云硬盘快照状态，取值可参考："[云硬盘快照状态。](https://support.huaweicloud.com/api-evs/evs_04_0041.html)"。 - size：云硬盘快照大小，单位为GiB。 - created_at：云硬盘快照创建时间。 **默认取值** created_at | | sort_dir | 否 | String | **参数解释** 返回结果按照降序或升序排列，默认为"desc"。 **约束限制** 不涉及。 **取值范围** - desc：降序。 - asc：升序。 **默认取值** desc | | id | 否 | String | **参数解释** 快照ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | ids | 否 | String | **参数解释** 快照id列表，多个id直接用,号隔开，格式为ids=id1,id2,...,idx。返回有效id对应的快照信息，无效的id会被忽略。 **约束限制** 最多支持一次查询60个id。 如果"id"和"ids"查询参数同时存在，"id"会被忽略。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | snapshot_type | 否 | String | **参数解释** 快照来源。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释** 快照的企业项目ID。 关于企业项目ID的获取及企业项目特性的详细信息，请参考："[企业管理用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0123692049.html)"。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | tag_key | 否 | String | **参数解释** 快照标签的key。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | tags | 否 | String | **参数解释** 快照标签的key/value对，例如\[{"key":"bbb","value":"bbb"}\]。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | snapshot_chain_id | 否 | String | **参数解释** 快照链ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | snapshot_group_id | 否 | String | **参数解释** 快照一致性组ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snapshots | Array of [SnapshotDetailV5] objects | **参数解释** 快照信息。 **取值范围** 不涉及。 | 表5SnapshotDetailV5 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释** 云硬盘快照的状态。 **取值范围** 具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 | | 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\ | **参数解释** 快照所属标签。 标签的key：String类型，最大长度36个字符。 由英文字母、数字、下划线、中划线、UNICODE字符（\\u4E00-\\u9FFF）组成。 标签的value：String类型，最大长度43个字符，可以为空字符串。 由英文字母、数字、下划线、点、中划线、UNICODE字符（\\u4E00-\\u9FFF）组成。 **取值范围** 不涉及。 | | 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。 **取值范围** 不涉及。 | 表6SnapshotChains | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 快照链ID。 **取值范围** 不涉及。 | | availability_zone | String | **参数解释** 快照链所属云硬盘的可用区。 **取值范围** 不涉及。 | | snapshot_count | Integer | **参数解释** 快照链上的快照个数。 **取值范围** 大于等于0。 | | capacity | Integer | **参数解释** 快照链的大小。 **取值范围** 大于等于0。 | | project_id | String | **参数解释** 项目ID。 **取值范围** 不涉及。 | | volume_id | String | **参数解释** 快照链所属的云硬盘ID。 **取值范围** 不涉及。 | | category | String | **参数解释** 快照链的类型。 **取值范围** 当前快照链支持"standard"、"standard_copy"两种类型。 | | created_at | String | **参数解释** 创建时间。 **取值范围** 不涉及。 | | updated_at | String | **参数解释** 更新时间。 **取值范围** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误信息。 **取值范围** 不涉及。 | 表8Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请[参考错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v5/{project_id}/snapshots/detail ``` #### 响应示例 **状态码：200** OK ``` { "snapshots" : [ { "status" : "available", "description" : null, "created_at" : "2013-06-19T07:15:29.000000", "volume_id" : "ae11e59c-bd56-434a-a00c-04757e1c066d", "size" : "5", "id" : "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa", "name" : "name_xx2-snap", "updated_at" : null, "category" : "flash", "enterprise_project_id" : "0", "encrypted" : false, "availability_zone" : "az1.dc1", "tags" : { } }, { "status" : "available", "description" : null, "created_at" : "2013-06-19T09:08:08.000000", "volume_id" : "ae11e59c-bd56-434a-a00c-04757e1c066d", "size" : "5", "id" : "b3253e26-5c37-48dd-8bf2-8795dd1e848f", "name" : "name_xx2-snap", "updated_at" : null, "category" : "flash", "enterprise_project_id" : "0", "encrypted" : false, "availability_zone" : "az1.dc1", "tags" : { } } ] } ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "EVS.XXX" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。