> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/zec/disk-snapshot/describesnapshots.md).

# DescribeSnapshots

## 1. 接口描述

本接口(DescribeSnapshots)用于查询快照的详细信息。

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称            | 必选 | 类型                                                                                | 描述                                                                                                             |
| --------------- | -- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| snapshotIds     | 否  | Array of String                                                                   | 根据快照ID列表进行过滤。                                                                                                  |
| zoneId          | 否  | String                                                                            | <p>快照所属的可用区ID。</p><p>可通过调用 <a href="/api-reference/cn/zec/location/describezones.md">DescribeZones</a> 获取。</p> |
| status          | 否  | [SnapshotStatusValue](/api-reference/cn/zec/datastructure.md#snapshotstatusvalue) | 根据快照的状态过滤。                                                                                                     |
| diskIds         | 否  | Array of String                                                                   | <p>按照快照所属的云硬盘ID过滤。</p><p>可通过调用 <a href="/api-reference/cn/zec/disk/describedisks.md">DescribeDisks</a> 获取。</p> |
| diskType        | 否  | [DiskType](/api-reference/cn/zec/datastructure.md#disktype)                       | 根据快照的云盘类型过滤。                                                                                                   |
| snapshotType    | 否  | [SnapshotType](/api-reference/cn/zec/datastructure.md#snapshottype)               | 根据快照类型过滤。                                                                                                      |
| snapshotName    | 否  | String                                                                            | <p>根据快照显示名称过滤。</p><p>该字段支持模糊搜索。</p>                                                                            |
| pageSize        | 否  | Integer                                                                           | <p>返回的分页大小。</p><p>默认值：20</p>                                                                                   |
| pageNum         | 否  | Integer                                                                           | <p>返回的分页数。</p><p>默认值：1</p>                                                                                     |
| resourceGroupId | 否  | String                                                                            | 根据资源组ID过滤。                                                                                                     |

## 3. 响应结果

| 参数名称       | 类型                                                                           | 描述                                                       |
| ---------- | ---------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId  | String                                                                       | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                      | 满足过滤条件的快照总数。                                             |
| dataSet    | Array of [SnapshotInfo](/api-reference/cn/zec/datastructure.md#snapshotinfo) | 返回的快照列表数据。                                               |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 查询快照列表。**

```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeSnapshots
<Common Request Params>

Request：
{
    "snapshotIds": ["snapshotId1","snapshotId2"],
    "zoneId": "asia-east-1a",
    "status": "AVAILABLE",
    "snapshotName": "snapshot-state",
    "pageSize": 20,
    "pageNum": 1
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "totalCount": 1,
    "dataSet": [
      {
        "snapshotId": "<snapshotId>",
        "snapshotName": "snapshotName",
        "zoneId": "asia-east-1a",
        "status": "AVAILABLE",
        "diskId": "<diskId>",
        "createTime": "2025-07-02T09:51:00Z",
        "resourceGroupId": "0a253bb0-eb7d-4328-84ec-fc8d1487b31a",
        "resourceGroupName": "Default Resource Group"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码 | 说明 |
| ------- | --- | -- |