# 查询云硬盘快照详情列表 - ListSnapshots #### 功能介绍 查询云硬盘快照详情列表。 #### 调用方法 请参见[如何调用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 /v2/{project_id}/cloudsnapshots/detail 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-evs/evs_04_0046.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释** 偏移量。 说明:分页查询快照时使用，与limit配合使用。假如共有30个快照，设置offset为11，limit为10，即为从第12个快照开始查询，一次最多可读取10个快照。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | limit | 否 | Integer | **参数解释** 返回结果个数限制。 **约束限制** 不涉及。 **取值范围** 值为大于0的整数。 **默认取值** 1000 | | name | 否 | String | **参数解释** 云硬盘快照名称。 **约束限制** 不涉及。 **取值范围** 最大支持64个字符。 **默认取值** 不涉及。 | | status | 否 | String | **参数解释** 云硬盘快照状态，具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | volume_id | 否 | String | **参数解释** 快照所属云硬盘的ID。 可通过[查询所有云硬盘详情](https://support.huaweicloud.com/api-evs/evs_04_2006.html)获取云硬盘ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | availability_zone | 否 | String | **参数解释** 快照所属云硬盘的可用区。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | id | 否 | String | **参数解释** 指定快照id进行过滤。 **约束限制** 可以传入多个id过滤查询，格式：id=id1\&id=id2\&id=id3 **取值范围** 不涉及。 **默认取值** 不涉及。 | | dedicated_storage_name | 否 | String | **参数解释** 专属存储的名称。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | dedicated_storage_id | 否 | String | **参数解释** 专属存储ID。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | | service_type | 否 | String | **参数解释** 服务类型。 **约束限制** 不涉及。 **取值范围** - EVS：云硬盘。 - DSS：专属分布式存储服务。 - DESS：专属企业存储服务。 **默认取值** 不涉及。 | | enterprise_project_id | 否 | String | **参数解释** 指定企业项目id进行过滤。 传入"all_granted_eps"，代表查询权限范围内的所有企业项目下的云硬盘。 关于企业项目ID的获取及企业项目特性的详细信息，请参考："[企业管理用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0123692049.html)"。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制** 不涉及。 **取值范围** 不涉及。 **默认取值** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释** 快照的总数量，不受limi参数的影响。 **取值范围** 不涉及。 | | snapshots | Array of [SnapshotList] objects | **参数解释** 快照信息。 **取值范围** 不涉及。 | | snapshots_links | Array of [Link] objects | **参数解释** 云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段，返回该字段表示本次查询只查出了部分云硬盘快照信息。 **取值范围** 不涉及。 | 表5SnapshotList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** 云硬盘快照ID。 **取值范围** 不涉及。 | | status | String | **参数解释** 云硬盘快照的状态。 **取值范围** 具体请参见[云硬盘快照状态](https://support.huaweicloud.com/api-evs/evs_04_0041.html)。 | | name | String | **参数解释** 云硬盘快照名称。 **取值范围** | | description | String | **参数解释** 云硬盘快照描述信息。 **取值范围** 不涉及。 | | created_at | String | **参数解释** 云硬盘快照创建时间。 **取值范围** 不涉及。 | | updated_at | String | **参数解释** 云硬盘快照更新时间。 **取值范围** 不涉及。 | | metadata | Map\ | **参数解释** 云硬盘的metadata信息 ，调用方可以添加或删除metadata信息。当前部分key在EVS服务中有业务场景含义，这部分key的描述如下： - \[__system__cmkid\] metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 请求获取密钥ID的方法请参考："[查询密钥列表](https://support.huaweicloud.com/api-dew/ListKeys.html)"。 - \[__system__encrypted\] metadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定该字段时,云硬盘的加密属性与数据源保持一致,如果不是从数据源创建的场景,则默认不加密。 - \[hw:passthrough\] - true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 - false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 - 该字段不存在时，云硬盘默认为VBD类型。 **取值范围** 不涉及。 | | volume_id | String | **参数解释** 快照所属的云硬盘。 **取值范围** 不涉及。 | | size | Integer | **参数解释** 云硬盘快照大小。 **取值范围** 不涉及。 | | os-extended-snapshot-attributes:project_id | String | **参数解释** 项目ID。 **取值范围** 不涉及。 | | os-extended-snapshot-attributes:progress | String | **参数解释** 快照进度。 **取值范围** 不涉及。 | | dedicated_storage_id | String | **参数解释** 专属存储ID。 **取值范围** 不涉及。 | | dedicated_storage_name | String | **参数解释** 专属存储名称。 **取值范围** 不涉及。 | | service_type | String | **参数解释** 服务类型。 **取值范围** - EVS：云硬盘。 - DSS：专属分布式存储服务。 - DESS：专属企业存储服务。 | 表6Link | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | **参数解释** 对应的快捷链接。 **取值范围** 不涉及。 | | rel | String | **参数解释** 快捷链接标记名称。 **取值范围** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [Error] object | **参数解释** 出现错误时，返回的错误码。错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 **取值范围** 包含错误码和错误消息的对象 | 表8Error | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 出现错误时，返回的错误码。 **取值范围** 错误码和其对应的含义请参考[错误码说明](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。 | | message | String | **参数解释** 出现错误时，返回的错误消息。 **取值范围** 描述错误消息的字符串 | #### 请求示例 - 查询快照id为c311bb8d-17f1-4e99-aaf9-e132c0391a73和c7691083-15fa-4045-956c-2bcbfe1b9976的快照详情，从第1条记录开始查询，返回结果中的记录数不超过100个。 ``` GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail?id=c311bb8d-17f1-4e99-aaf9-e132c0391a73&id=c7691083-15fa-4045-956c-2bcbfe1b9976&offset=0&limit=100 ``` - 查询id为f8c7cce6-ec47-43ca-9297-b5604668b08f的云硬盘的所有快照详情。 ``` GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail?volume_id=f8c7cce6-ec47-43ca-9297-b5604668b08f&service_type=EVS ``` #### 响应示例 **状态码：200** OK ``` { "count" : 3, "snapshots_links" : [ { "href" : "https://{endpoint}/v2/20a68d6b7a124ae2b6b8a22046ee5966/cloudsnapshots/detail?limit=1&marker=fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67", "rel" : "next" } ], "snapshots" : [ { "status" : "available", "updated_at" : "2018-06-06T10:58:47.349051", "volume_id" : "f687bd70-37b3-4f00-a900-0ba1cfaa5196", "id" : "fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67", "size" : 1, "os-extended-snapshot-attributes:progress" : "100%", "name" : "test03", "os-extended-snapshot-attributes:project_id" : "20a68d6b7a124ae2b6b8a22046ee5966", "service_type" : "EVS", "created_at" : "2018-05-30T03:14:44.457975", "metadata" : { } } ] } ``` **状态码：400** Bad Request ``` { "error" : { "message" : "XXXX", "code" : "XXX" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.evs.v2.region.EvsRegion; import com.huaweicloud.sdk.evs.v2.*; import com.huaweicloud.sdk.evs.v2.model.*; public class ListSnapshotsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EvsClient client = EvsClient.newBuilder() .withCredential(auth) .withRegion(EvsRegion.valueOf("")) .build(); ListSnapshotsRequest request = new ListSnapshotsRequest(); try { ListSnapshotsResponse response = client.listSnapshots(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkevs.v2.region.evs_region import EvsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkevs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EvsClient.new_builder() \ .with_credentials(credentials) \ .with_region(EvsRegion.value_of("")) \ .build() try: request = ListSnapshotsRequest() response = client.list_snapshots(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" evs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/evs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := evs.EvsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := evs.NewEvsClient(hcClient) request := &model.ListSnapshotsRequest{} response, err := client.ListSnapshots(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EVS/sdk?api=ListSnapshots)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-evs/evs_04_0038.html)。