Query automatic snapshot tasks using DescribeAutoSnapshotTasks - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

This feature is in free public preview. During the public preview, the File Storage NAS Service-Level Agreement (SLA) is not guaranteed.
Only Advanced Extreme NAS supports this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeAutoSnapshotTasks

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemIds	string	No	The IDs of the file systems. You can specify up to 100 file system IDs in a single request. To query snapshots of multiple file systems, separate the file system IDs with commas (,).	extreme-233e6**,extreme -23vbp,extreme -23vas**
AutoSnapshotPolicyIds	string	No	The IDs of the automatic snapshot policies. You can specify up to 100 automatic snapshot policy IDs. To query tasks of multiple automatic snapshot policies, 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 values: extreme (Extreme NAS file system) Valid values: extreme : Extreme NAS file system.	extreme
PageSize	integer	No	The page number of the automatic snapshot task list. Start value (default value): 1	1
PageNumber	integer	No	The number of snapshot tasks on each page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	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 for the paging query.	10
PageNumber	integer	The page number of the automatic snapshot task list.	1
AutoSnapshotTasks	object
AutoSnapshotTask	array<object>	The collection of automatic snapshot task information.
	object
SourceFileSystemId	string	The ID of the file system.	extreme-233e6****
AutoSnapshotPolicyId	string	The ID of the automatic snapshot policy.	sp-extreme-233e6****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.