All Documents
Current Document

Recommend

Container Engine Virtual Private Cloud Standard Storage Service

Found 0 result in total

Content is empty

If you don't find the content you expect, please try another search term

Documentation

Elastic Block Storage (EBS)

View more results
Document title with current keyword not found
Directory
Expand AllFold All Up
No products found with this keyword
Documentation Elastic Block Storage (EBS) API Reference API operations for snapshots DescribeSnapshots

DescribeSnapshots

Last updated：2021-10-26 22:50:29

1. Description

You can call this operation to query snapshots by EBS volume, availability zone, or EBS volume category.

2. Request parameters

Parameter Type Required Description
VolumeId String No The ID of the EBS volume. You can specify this parameter to query all snapshots of the EBS volume. If this parameter is specified, the VolumeCategory, SnapshotId, and AvailabilityZone parameters are invalid.
VolumeCategory String No The category to which the EBS volume belongs. Valid values: system and data. You can specify this parameter to query snapshots of EBS volumes that belong to the specified category.
SnapshotId String No The ID of the snapshot. You can specify this parameter to query the specified snapshot. If this parameter is specified, the VolumeId, VolumeCategory, and AvailabilityZone parameters are invalid.
AvailabilityZone String No The availability zone. You can specify this parameter to query snapshots of EBS volumes that reside in the specified availability zone.
SnapshotName String No The name of the snapshot. You can specify this parameter to query the specified snapshot.
PageNumber Integer No The number of the page to return. Default value: 1. Value range: 1 to intMax.
PageSize Integer No The number of entries to return on each page. Default value: 10. Value range: 1 to intMax.

3. Response parameters

Parameter Type Description
RequestId String The request ID, which is unique. A request ID is returned for each request.
Snapshots List The list of information about the snapshots. This parameter is not returned if no snapshot is available.

4. Examples

Request parameters

http://ebs.api.ksyun.com/
?Action=DescribeSnapshots
&Version=2016-03-04
&VolumeCategory=data
&VolumeId=b01cbcb3-04dd-40c8-bfbb-dc990d54ee68

Response parameters

 "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
    }
On this page
Previous:DeleteSnapshot
Next:ModifySnapshot
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback