All Products
Search
Document Center

Apsara File Storage NAS:DescribeAutoSnapshotTasks

Last Updated:Mar 14, 2024

Queries automatic snapshot tasks.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdsstringNo

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 (,).

extreme-233e6****,extreme -23vbp****,extreme -23vas****
AutoSnapshotPolicyIdsstringNo

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 (,).

sp-extreme-233e6****,sp-extreme-233e6****, sp-extreme-233e6****
FileSystemTypestringYes

The type of the file system.

Valid value: extreme, which indicates Extreme NAS file systems.

extreme
PageSizeintegerNo

The page number.

Pages start from page 1. Default value: 1.

1
PageNumberintegerNo

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of automatic snapshot tasks.

9
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
AutoSnapshotTasksobject []

The queried automatic snapshot tasks.

SourceFileSystemIdstring

The ID of the file system.

extreme-233e6****
AutoSnapshotPolicyIdstring

The ID of the automatic snapshot policy.

sp-extreme-233e6****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 9,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageSize": 10,
  "PageNumber": 1,
  "AutoSnapshotTasks": {
    "AutoSnapshotTask": [
      {
        "SourceFileSystemId": "extreme-233e6****",
        "AutoSnapshotPolicyId": "sp-extreme-233e6****"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.