DescribeSnapshots -

Usage notes

The snapshot feature is in public preview and is provided free of charge. Apsara File Storage NAS Service Level Agreement (SLA) is not guaranteed in public preview.
Only advanced Extreme NAS file systems support this feature.

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. Valid value: extreme, which indicates Extreme NAS file systems.
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 snapshots. You can specify a maximum of 100 IDs. You must separate snapshot IDs with commas (,).
SnapshotName	String	No	FinanceJoshua	The snapshot name.
SnapshotType	String	No	all	The snapshot type. Valid values: auto: auto snapshots user: manual snapshots all (default): all snapshots
Status	String	No	all	The snapshot status. Valid values: progressing: The snapshot is being created. accomplished: The snapshot is created. failed: The snapshot fails to be created. all (default): all snapshot states.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100 Default value: 10
PageNumber	Integer	No	1	The page number. Pages start from page 1. Default value: 1.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	36	The total number of returned snapshots.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	The request ID.
PageSize	Integer	10	The number of entries per page.
PageNumber	Integer	1	The page number.
Snapshots	Array of Snapshot		The details about snapshots.
Snapshot
Status	String	accomplished	The snapshot status. Valid values: progressing: The snapshot is being created. accomplished: The snapshot is created. failed: The snapshot fails to be created.
Progress	String	100	The progress of the snapshot creation. The value of this parameter is expressed as a percentage.
CreateTime	String	2014-07-24T13:00:52Z	The time when the snapshot was created. The time follows the ISO 8601 standard in UTC. The time is displayed in the `yyyy-MM-ddThh:mmZ` format.
SourceFileSystemId	String	extreme-012****	The ID of the source file system. This parameter is retained even if the source file system of the snapshot is deleted.
RetentionDays	Integer	30	The retention period of the auto snapshot. Unit: days. Valid values: -1: Auto snapshots are permanently retained. After the number of auto snapshots exceeds the upper limit, the earliest auto snapshot is automatically deleted. 1 to 65536: Auto snapshots are retained for the specified days. After the retention period of auto snapshots expires, the auto snapshots are automatically deleted.
RemainTime	Integer	38	The remaining time that is required to create the snapshot. Unit: seconds.
SourceFileSystemSize	Long	2000	The capacity of the source file system. Unit: GiB.
SourceFileSystemVersion	String	1	The version of the source file system.
SnapshotName	String	FinanceJoshua	The snapshot name. If you specify a name to create a snapshot, the name of the snapshot is returned. Otherwise, no value is returned for this parameter.
EncryptType	Integer	1	Indicates whether the snapshot is encrypted. Valid values: 0: The snapshot is not encrypted. 1: The snapshot is encrypted.
Description	String	FinanceDept	The snapshot description.
SnapshotId	String	s-extreme-snapsho****	The snapshot ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSnapshots
&FileSystemType=extreme
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.