# 查询快照列表 - CinderListSnapshotsV3 #### 功能介绍 查询快照列表。 #### 调用方法 请参见[如何调用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)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{project_id}/snapshots 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | 分页查询的起始资源id，取值为上一页最后一条查询记录的资源id。 | | offset | 否 | Integer | 偏移量。 说明： 说明： 分页查询快照时使用，与limit配合使用。假如共有30个快照，设置offset为11，limit为10，即为从第12个快照开始查询，一次最多可读取10个快照 | | limit | 否 | Integer | 返回结果个数限制。 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 当租户所有的快照数量大于50个时，为了提升您的查询效率，建议查询的时候使用limit参数，并且参数值最大设置为50。查询示例： GET /v2/xxx/snapshots?limit=50，表示查询第1\~50个快照。GET /v2/xxx/snapshots?offset=50\&limit=50，表示查询第51\~100个快照。 | | name | 否 | String | 快照名称，不支持模糊匹配。最大支持255个字符。 | | status | 否 | String | 快照状态，具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 | | volume_id | 否 | String | 快照对应的云硬盘ID。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snapshots_links | Array of [Link] objects | 云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段，返回该字段表示本次查询只查出了部分云硬盘快照信息。 | | snapshots | Array of [SnapshotSummary] objects | 快照信息。 | 表5Link | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | **参数解释** 对应的快捷链接。 **取值范围** 不涉及。 | | rel | String | **参数解释** 快捷链接标记名称。 **取值范围** 不涉及。 | 表6SnapshotSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | created_at | String | 云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX | | description | String | 云硬盘快照描述信息。 | | id | String | 云硬盘快照ID。 | | metadata | Map\ | 云硬盘快照的元数据信息。 如果元数据中包含__system__enableActive字段，则表示该快照为云服务器创建备份时自动生成的快照。 | | name | String | 云硬盘快照名称。 | | size | Integer | 云硬盘快照大小，单位为GiB。 | | status | String | 云硬盘快照状态，具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 | | updated_at | String | 快照更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX | | volume_id | String | 快照所属的云硬盘ID。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误信息。 **取值范围** 不涉及。 | 表8Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请[参考错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/{project_id}/snapshots?status=available ``` #### 响应示例 **状态码：200** OK ``` { "snapshots" : [ { "created_at" : "2016-02-16T16:54:14.981520", "description" : null, "id" : "b836dc3d-4e10-4ea4-a34c-8f6b0460a583", "metadata" : { }, "name" : "test01", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null }, { "created_at" : "2016-02-16T16:54:19.475397", "description" : null, "id" : "83be494d-329e-4a78-8ac5-9af900f48b95", "metadata" : { }, "name" : "test02", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null }, { "created_at" : "2016-02-16T16:54:24.367414", "description" : null, "id" : "dd360f46-7593-4d35-8f2c-5566fd0bd79e", "metadata" : { }, "name" : "test03", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null }, { "created_at" : "2016-02-16T16:54:29.766740", "description" : null, "id" : "4c29796a-8cf4-4482-9afc-e66da9a81240", "metadata" : { }, "name" : "test04", "size" : 1, "status" : "available", "volume_id" : "ba5730ea-8621-4ae8-b702-ff0ffc12c209", "updated_at" : null } ], "snapshots_links" : null } ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "EVS.XXX" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。