Queries the details of automatic snapshot tasks.

Description

The API operation is available only for 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 dynamically 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 file system. Valid value: extreme.
FileSystemIds String No extreme-233e6ylv0,extreme -23vbpbi03,extreme -23vasz3ds

The IDs of file systems. You can specify a maximum of 100 IDs. If you want to query the snapshots of multiple file systems, you must separate multiple IDs with commas (,).

AutoSnapshotPolicyIds String No sp-extreme-233e6ylv0,sp-extreme-233e6ylv1, sp-extreme-233e6ylv2

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

PageSize Integer No 1

The number of entries to return on each page.

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

The number of the page to return.

  • Maximum value: 100.
  • Default value: 10.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.
TotalCount Integer 9

The total number of automatic snapshot tasks.
PageSize Integer 100

The number of entries returned per page.
PageNumber Integer   1

The page number of the returned page.
AutoSnapshotTasks Array

The details of automatic snapshot tasks.
SourceFileSystemId String extreme-233e6ylv0

The ID of each file system.
AutoSnapshotPolicyId String sp-extreme-233e6ylv0

The ID of each automatic snapshot policy.

Examples

Sample requests

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

Sample success responses

XML format 

<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<AutoSnapshotTasks>
    <AutoSnapshotTask>
        <SourceFileSystemId>extreme-032b5936</SourceFileSystemId>
        <AutoSnapshotPolicyId>sp-extreme-03v0xyq4k4u8h1238r</AutoSnapshotPolicyId>
    </AutoSnapshotTask>
</AutoSnapshotTasks>
<PageSize>10</PageSize>
<RequestId>D901BDD5-2D6B-4479-A464-1FCA13F737FC</RequestId>

JSON format 

{
    "PageNumber": 1,
    "TotalCount": 1,
    "AutoSnapshotTasks": {
        "AutoSnapshotTask": [
            {
                "SourceFileSystemId": "extreme-233e6ylv0",
                "AutoSnapshotPolicyId": "sp-extreme-233e6ylv0"
            }
        ]
    },
    "PageSize": 10,
    "RequestId": "D901BDD5-2D6B-4479-A464-1FCA13F737FC"
}

Error codes

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