最近更新时间：2024.04.25 17:11:26
首次发布时间：2022.04.28 10:05:43
调用DescribeSnapshots接口查询快照列表。
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeSnapshots | 要执行的操作，取值：DescribeSnapshots |
| SnapshotIds.N | String | 否 | SnapshotIds.1=snap-31akybwsxi8rudc6****&SnapshotIds.2=snap-31ak39j5bh8rubsn**** | 需要查询的快照ID。 |
| VolumeId | String | 否 | vol-bp1s5fnvk4gn2tws0**** | 快照相关的云盘ID。 |
| SnapshotName | String | 否 | testSnapshotName | 快照名称。 |
SnapshotStatus.N | Aarray | 否 | available | 快照状态，取值说明如下：
|
| ZoneId | String | 否 | cn-beijing-a | 可用区ID。 |
| PageSize | Int | 否 | 10 | 每页查询数量，默认为10。 |
| PageNumber | Int | 否 | 1 | 起始页，默认为1。 |
| Filter.1.Key | String | 否 | CreationStartTime | 查询资源时的筛选键，取值必须为CreationStartTime。同时设置Filter.1.Key和Filter.1.Value可以查询在指定时间点后创建的资源信息。 |
| Filter.1.Value | String | 否 | 2019-12-13T17:00Z | 查询资源时的筛选值。指定该参数时必须同时指定Filter.1.Key参数，格式为：yyyy-MM-ddTHH:mmZ，采用UTC +0时区。 |
| Filter.2.Key | String | 否 | CreationEndTime | 查询资源时的筛选键，取值必须为CreationEndTime。同时设置Filter.2.Key和Filter.2.Value可以查询在指定时间点前创建的资源信息。 |
| Filter.2.Value | String | 否 | 2019-12-13T22:00Z | 查询资源时的筛选值。指定该参数时必须同时指定Filter.2.Key参数，格式为：yyyy-MM-ddTHH:mmZ，采用UTC +0时区。 |
| ProjectName | String | 否 | default | 根据快照所属的Project（项目）名筛选快照。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=tag | 根据标签查询资源时指定的标签键。说明如下：
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test | 根据标签查询资源时指定的标签值。说明如下：
|
| 名称 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| PageSize | Int | 1 | 每页查询数量。 |
| PageNumber | Int | 10 | 查询起始页。 |
| TotalCount | Int | 1 | 查询的快照总个数。 |
| Snapshots | Array of Snapshot | - | 快照详情集合，具体请参见下表“Snapshots结构”。 |
| 名称 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| CreationTime | String | 2021-12-12 03:33:04.374716 | 快照创建时间。 |
| Description | String | test | 快照描述信息。 |
| SnapshotId | String | snap-3tigy72q3u3vj0x2**** | 快照ID。 |
| SnapshotName | String | snapshotname | 快照名称。 |
SnapshotType | String | user | 快照类型，取值说明如下：
|
Status | String | available | 快照状态，取值说明如下：
|
| VolumeId | String | vol-bp1s5fnvk4gn2tws0**** | 云盘ID。 |
VolumeKind | String | system | 云盘种类，取值说明如下：
|
| VolumeName | String | test | 云盘名称。 |
| VolumeSize | Int | 20 | 云盘大小，单位为GiB。 |
| VolumeStatus | String | available | 云盘状态，取值说明如下： |
VolumeType | String | ESSD_PL0 | 云盘类型，取值说明如下：
|
| ZoneId | String | cn-beijing-a | 快照所在的可用区ID。 |
| RetentionDays | Int | 30 | 自动快照的保留天数。 |
| ProjectName | String | default | 快照所属项目。 |
| Tags | Array of Struct | - | 快照的标签信息，具体请参见下表“ Tag结构 ”。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | tag | 快照的标签键。 |
| Value | String | test | 快照的标签值。 |
GET /?Action=DescribeSnapshots&SnapshotIds.1=snap-31akybwsxi8rudc6****&SnapshotIds.2=snap-31ak39j5bh8rubsn****&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: storage_ebs
{ "ResponseMetadata": { "RequestId": "20220311010333010194099035060C0***", "Action": "DescribeSnapshots", "Version": "2020-04-01", "Service": "storage_ebs", "Region": "cn-beijing" }, "Result": { "PageNumber": 1, "PageSize": 10, "Snapshots": [{ "CreationTime": "2022-03-10T22:33:46+08:00", "Description": "test", "SnapshotId": "snap-31ak39j5bh8rubsn****", "SnapshotName": "snapshot2", "SnapshotType": "user", "Status": "available", "Tags": [ { "Key": "tag", "Value": "value" } ], "VolumeId": "vol-31ale588uo8rud93****", "VolumeKind": "data", "VolumeName": "snap_test", "VolumeSize": 20, "VolumeStatus": "available", "VolumeType": "ESSD_PL0", "ZoneId": "cn-beijing-b" "ProjectName": "default" }, { "CreationTime": "2022-03-10T21:57:14+08:00", "Description": "test", "SnapshotId": "snap-31akybwsxi8rudc6****", "SnapshotName": "snapshot", "SnapshotType": "user", "Status": "available", "Tags": [ { "Key": "tag", "Value": "value" } ], "VolumeId": "vol-31ale588uo8rud93****", "VolumeKind": "data", "VolumeName": "snap_test", "VolumeSize": 20, "VolumeStatus": "available", "VolumeType": "ESSD_PL0", "ZoneId": "cn-beijing-b" "ProjectName": "default" }], "TotalCount": 2 } }
| HttpCode | 错误码 | 错误信息 |
|---|---|---|
| 404 | InvalidFilterValue | FilterValue非法 |