Queries all snapshots of a file system.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSnapshots

The operation that you want to perform.

Set the value to DescribeSnapshots.

FileSystemType String Yes extreme

The type of the file system. Set the value to extreme.

FileSystemId String No extreme-22f****

The ID of the file system.

SnapshotIds String No s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh****

The IDs of the snapshots. You can specify a maximum of 100 IDs. You must separate snapshot IDs with commas (,).

SnapshotName String No FinanceJoshua

The name of the snapshot.

SnapshotType String No all

The type of the snapshot. Default value: all. Valid values:

  • auto: automatic snapshot
  • user: manual snapshot
  • all: all snapshot types
Status String No all

The status of the snapshot. Default value: all. Valid values:

  • progressing: The snapshot is being created.
  • accomplished: The snapshot is created.
  • failed: The snapshot fails to be created.
  • all: All snapshot statuses.
PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100. Default value: 10.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Snapshots Array

The information of the snapshots.

Snapshot
CreateTime String 2014-07-24T13:00:52Z

The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time is displayed in UTC.

Description String FinanceDept

The description of the snapshot.

EncryptType Integer 1

Indicates whether data that is stored in the file system is encrypted.

  • 0: The data is not encrypted.
  • 1: The data is encrypted.
Progress String 100

The progress of the snapshot creation task. Unit: percent.

RemainTime Integer 38

The remaining time until the snapshot is created. Unit: seconds.

RetentionDays Integer 30

The number of days for which an automatic snapshot is retained.

SnapshotId String s-extreme-snapsho****

The ID of the snapshot.

SnapshotName String FinanceJoshua

The name of the snapshot. If you specify a snapshot name when you call this operation, this parameter is returned.

SourceFileSystemId String extreme-012****

The ID of the source file system. If the source file system is deleted, this parameter remains unchanged.

SourceFileSystemSize Long 2000

The capacity of the source file system. Unit: GB.

SourceFileSystemVersion String 1

The version of the source file system.

Status String accomplished

The status of the snapshot. Valid values: progressing, accomplished, and failed.

TotalCount Integer 36

The total number of snapshots.

Examples

Sample requests

GET https://nas.cn-hangzhou.aliyuncs.com/?Action=DescribeSnapshots
&FileSystemType=extreme
&<Common request parameters>
…

Sample success responses

XML format

<TotalCount>36</TotalCount>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Snapshots>
    <Snapshot>
        <Status>accomplished</Status>
        <SnapshotId>s-extreme-snapsho****</SnapshotId>
        <Progress>100</Progress>
        <SourceFileSystemSize>2000</SourceFileSystemSize>
        <Description>FinanceDept</Description>
        <EncryptType>1</EncryptType>
        <SourceFileSystemVersion>1</SourceFileSystemVersion>
        <CreateTime>2014-07-24T13:00:52Z</CreateTime>
        <SourceFileSystemId>extreme-012****</SourceFileSystemId>
        <RetentionDays>30</RetentionDays>
        <RemainTime>38</RemainTime>
        <SnapshotName>FinanceJoshua</SnapshotName>
    </Snapshot>
</Snapshots>

JSON format

{
    "TotalCount": 36,
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "PageSize": 10,
    "PageNumber": 1,
    "Snapshots": {
        "Snapshot": {
            "Status": "accomplished",
            "SnapshotId": "s-extreme-snapsho****",
            "Progress": 100,
            "SourceFileSystemSize": 2000,
            "Description": "FinanceDept",
            "EncryptType": 1,
            "SourceFileSystemVersion": 1,
            "CreateTime": "2014-07-24T13:00:52Z",
            "SourceFileSystemId": "extreme-012****",
            "RetentionDays": 30,
            "RemainTime": 38,
            "SnapshotName": "FinanceJoshua"
        }
    }
}

Error codes

For a list of error codes, visit the API Error Center.