Queries the information about one or more snapshots of a file system.
Operation description
- 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
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
FileSystemType | string | Yes | The type of the file system. Valid value: extreme, which indicates Extreme NAS file systems. | extreme |
FileSystemId | string | No | The ID of the file system. | extreme-22f**** |
SnapshotIds | string | No | The snapshot IDs. You can specify a maximum of 100 snapshot IDs. You must separate snapshot IDs with commas (,). | s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh**** |
SnapshotName | string | No | The snapshot name. | FinanceJoshua |
SnapshotType | string | No | The type of the snapshot. Valid values:
| all |
Status | string | No | The status of the snapshot. Valid values:
| all |
PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 10 |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalCount": 36,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageSize": 10,
"PageNumber": 1,
"Snapshots": {
"Snapshot": [
{
"Status": "accomplished",
"Progress": "100",
"CreateTime": "2014-07-24T13:00:52Z",
"SourceFileSystemId": "extreme-012****",
"RetentionDays": 30,
"RemainTime": 38,
"SourceFileSystemSize": 2000,
"SourceFileSystemVersion": "1",
"SnapshotName": "FinanceJoshua",
"EncryptType": 1,
"Description": "FinanceDept",
"SnapshotId": "s-extreme-snapsho****"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.