查询快照列表

最近更新时间:2021-03-12 19:01:09

查看PDF

1. 接口描述

本接口(DescribeSnapshots)用于获取快照列表,可指定云盘,可用区或者云盘分类进行查询。

2. 请求参数

名称 类型 是否必需 描述
VolumeId String 云盘ID,传入该参数可获取指定硬盘的所有快照,此时其他三个参数无效
VolumeCategory String 硬盘分类,system(系统盘)或data(数据盘),传入该参数可获取指定类型的快照列表
SnapshotId String 快照ID,传入该参数可获取指定快照的信息,此时其他三个参数无效
AvailabilityZone String 可用区,传入该参数可获取指定可用区的快照信息
SnapshotName String 快照名称,传入可进行快照名称的查询
PageNumber Integer 页码,默认1,范围1-intMax
PageSize Integer 每页大小,默认10,范围1-intMax

3. 返回参数

名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回
Snapshots List 快照相关信息列表,若无信息则不返回

4. 示例

输入参数

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": "de4c8d96-af54-4bb7-8827-4cbff9373adf",
            "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": "de4c8d96-af54-4bb7-8827-4cbff9373adf",
            "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
    }

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈