全部文档
当前文档
最近更新时间：2022-07-12 18:29:59
本接口（DescribeSnapshots）用于获取快照列表，可指定云硬盘，可用区或者云硬盘分类进行查询。
| 名称 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| VolumeId | String | 否 | 云硬盘ID，传入该参数可获取指定硬盘的所有快照，此时其他三个参数无效 |
| VolumeCategory | String | 否 | 硬盘分类，system（系统盘）或data（数据盘），传入该参数可获取指定类型的快照列表 |
| SnapshotId | String | 否 | 快照ID，传入该参数可获取指定快照的信息，此时其他三个参数无效 |
| AvailabilityZone | String | 否 | 可用区，传入该参数可获取指定可用区的快照信息 |
| SnapshotName | String | 否 | 快照名称，传入可进行快照名称的查询 |
| PageNumber | Integer | 否 | 页码，默认1，范围1-intMax |
| PageSize | Integer | 否 | 每页大小，默认10，范围1-intMax |
| SnapshotStatus | String | 否 | 快照状态 available creating等 |
| SnapshotType | String | 否 | 快照类型 CommonSnapShot或者LocalSnapShot |
| VolumeType | String | 否 | 硬盘类型 比如 SSD3.0 |
| VolumeMultiType.N | String | 否 | 硬盘类型，支持传入多个类型，可查出传入的所有类型硬盘 PS：目前最多5个（SSD3.0/EHDD/ESSD_PL1/ESSD_PL2/ESSD_PL3） N为1~5 |
| Search | String | 否 | 根据快照ID模糊查询 |
| InstanceId | String | 否 | 主机实例ID，返回当前主机挂载的盘的快照信息 |
| VolumeIdSearch.N | String | 否 | 硬盘ID，传入该参数可获取指定硬盘的所有快照，此时其他三个参数无效 |
| Version | String | 是 | API版本号，传2016-03-04 |
| 名称 | 类型 | 是否必返回 | 描述 |
|---|---|---|---|
| RequestId | String | 是 | 唯一请求ID，每次请求都会返回 |
| Snapshots | List | 否 | 快照相关信息列表，包括快照ID、快照名称、云硬盘ID、快照容量、创建时间、快照状态、云硬盘属性、云硬盘名称、云硬盘类型、快照进度、所属可用区、云硬盘状态、快照类型；若无信息则不返回 |
输入参数
http://ebs.api.ksyun.com/
?Action=DescribeSnapshots
&Version=2016-03-04
&VolumeCategory=data
&VolumeId=b01cbcb3-04dd-40c8-bfbb-dc990d54ee68
返回参数
"RequestId": "6e2682a1-5968-42f5-80e5-284aae218df0",
"Snapshots": [
{
"SnapshotId": "8f4fd840-3921-42f3-94c1-dafd84e33e46",
"SnapshotName": "type_test",
"VolumeId": "b01cbcb3-04dd-40c8-bfbb-dc990d54ee68",
"Size": 10,
"CreateTime": "2020-09-08 12:15:25",
"SnapshotStatus": "available",
"VolumeCategory": "data",
"VolumeName": "ksc_ebs_20200908121229",
"VolumeType": "SSD3.0",
"Progress": "100%",
"AvailabilityZone": "cn-shanghai-3a",
"VolumeStatus": "available",
"SnapshotType": "LocalSnapShot"
},
{
"SnapshotId": "5205b47f-9d80-4434-adf4-f28acbba0b26",
"SnapshotName": "type_test",
"VolumeId": "b01cbcb3-04dd-40c8-bfbb-dc990d54ee68",
"Size": 10,
"CreateTime": "2020-09-08 12:14:30",
"SnapshotStatus": "available",
"VolumeCategory": "data",
"VolumeName": "ksc_ebs_20200908121229",
"VolumeType": "SSD3.0",
"Progress": "100%",
"AvailabilityZone": "cn-shanghai-3a",
"VolumeStatus": "available",
"SnapshotType": "CommonSnapShot"
}
],
"Page": {
"totalCount": 2,
"pageSize": 10,
"currentPage": 1,
"nextPage": 2,
"previousPage": 0,
"totalPageCount": 1,
"hasNext": false,
"hasPrevious": false,
"pageStartRow": 1,
"showPageNum": 5,
"pageList": [
1
],
"pageEndRow": 2
}
纯净模式