Queries a list of automatic snapshot tasks.
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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeAutoSnapshotTasks | The operation that you want to perform. Set the value to DescribeAutoSnapshotTasks. |
FileSystemIds | String | No | extreme-233e6****,extreme -23vbp****,extreme -23vas**** | The IDs of file systems. You can specify a maximum of 100 file system IDs. If you want to query the snapshots of multiple file systems, you must separate the file system IDs with commas (,). |
AutoSnapshotPolicyIds | String | No | sp-extreme-233e6****,sp-extreme-233e6****, sp-extreme-233e6**** | The IDs of automatic snapshot policies. You can specify a maximum of 100 policy IDs. If you want to query the tasks of multiple automatic snapshot policies, you must separate the policy IDs with commas (,). |
FileSystemType | String | Yes | extreme | The type of the file system. Valid value: extreme, which indicates Extreme NAS file systems. |
PageSize | Integer | No | 1 | The page number. Pages start from page 1. Default value: 1. |
PageNumber | Integer | No | 10 | The number of entries per page. Valid values: 1 to 100 Default value: 10 |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
TotalCount | Integer | 9 | The total number of automatic snapshot tasks. |
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. |
AutoSnapshotTasks | Array of AutoSnapshotTask | The queried automatic snapshot tasks. |
|
AutoSnapshotTask | |||
SourceFileSystemId | String | extreme-233e6**** | The ID of the file system. |
AutoSnapshotPolicyId | String | sp-extreme-233e6**** | The ID of the automatic snapshot policy. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeAutoSnapshotTasks
&FileSystemType=extreme
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAutoSnapshotTasksResponse>
<TotalCount>9</TotalCount>
<PageSize>10</PageSize>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
<PageNumber>1</PageNumber>
<AutoSnapshotTasks>
<AutoSnapshotTask>
<SourceFileSystemId>extreme-233e6****</SourceFileSystemId>
<AutoSnapshotPolicyId>sp-extreme-233e6****</AutoSnapshotPolicyId>
</AutoSnapshotTask>
</AutoSnapshotTasks>
</DescribeAutoSnapshotTasksResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 9,
"PageSize" : 10,
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber" : 1,
"AutoSnapshotTasks" : {
"AutoSnapshotTask" : [ {
"SourceFileSystemId" : "extreme-233e6****",
"AutoSnapshotPolicyId" : "sp-extreme-233e6****"
} ]
}
}
Error codes
For a list of error codes, see Service error codes.