DescribeAutoSnapshotTasks - File Storage NAS - Alibaba Cloud Documentation Center

Queries automatic snapshot tasks.

Operation description

The snapshot feature is in public preview and is provided free of charge. File Storage NAS Service Level Agreement (SLA) is not guaranteed in public preview.
Only advanced Extreme NAS file systems support the snapshot feature.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeAutoSnapshotTasks	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemIds	string	No	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**
AutoSnapshotPolicyIds	string	No	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**
FileSystemType	string	Yes	The type of the file system. Valid value: extreme, which indicates Extreme NAS file systems.	extreme
PageSize	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageNumber	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of automatic snapshot tasks.	9
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
AutoSnapshotTasks	array<object>	The queried automatic snapshot tasks.
AutoSnapshotTask	object
SourceFileSystemId	string	The ID of the file system.	extreme-233e6****
AutoSnapshotPolicyId	string	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.

Change history

Change time	Summary of changes	Operation
2024-09-05	API Description Update. The API operation is not deprecated.	View Change Details