Queries the list of automatic snapshot tasks.

Description

This API operation applies only to NAS Extreme file systems.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAutoSnapshotTasks

The operation that you want to perform.

Set the value to DescribeAutoSnapshotTasks.
FileSystemType String Yes extreme

The type of the file system.

Valid value: extreme, which indicates Extreme NAS file systems.
FileSystemIds String No extreme-233e6****,extreme -23vbp****,extreme -23vas****

The ID of the file system.

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 ID of the automatic snapshot policy.

You can specify a maximum of 100 snapshot IDs. If you want to query the tasks of multiple automatic snapshot policies, you must separate the file system IDs with commas (,).

PageSize Integer No 1

The number of the page to return.

Pages start from page 1. Default value: 1.
PageNumber Integer No 10

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

Response parameters

Parameter Type Example Description
AutoSnapshotTasks Array of AutoSnapshotTask

The list of automatic snapshot tasks.
AutoSnapshotTask
AutoSnapshotPolicyId String sp-extreme-233e6****

The ID of the automatic snapshot policy.
SourceFileSystemId String extreme-233e6****

The ID of the file system.
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-A3DC0DE3****

The ID of the request.
TotalCount Integer 9

The total number of automatic snapshot tasks.

Examples

Sample requests

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

Sample success responses

XML format 

<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>

JSON format 

{
    "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, visit the API Error Center.