Apply an automatic snapshot policy to file systems using ApplyAutoSnapshotPolicy - File Storage NAS - Alibaba Cloud - File Storage NAS

Operation description

Before you begin

Only Advanced Extreme NAS file systems support this operation. Before you call this operation, complete the following preparations:

An Advanced Extreme NAS file system is created. When you invoke the CreateFileSystem operation to create a file system, set the following parameters:
- FileSystemType: extreme
- StorageType: advance
An automatic snapshot policy is created. For more information, see CreateAutoSnapshotPolicy.
The AliyunNASManageENIRole console authorization is completed. Before you create an Extreme NAS file system, associate the service-linked role AliyunNASManageENIRole with File Storage NAS to allow NAS to manage elastic network interfaces (ENIs), which are network interface controller (NIC) resources. For more information, see Manage NAS service-linked roles.

Usage notes

This feature is in free public preview.
Each file system can have only one automatic snapshot policy applied.
An automatic snapshot policy can be applied to multiple file systems.
If the target file system already has an automatic snapshot policy applied, calling the ApplyAutoSnapshotPolicy operation replaces the current automatic snapshot policy of the file system.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AutoSnapshotPolicyId	string	Yes	The ID of the automatic snapshot policy.	sp-extreme-233e6****
FileSystemIds	string	Yes	The IDs of the Advanced Extreme NAS file systems. You can specify up to 100 file system IDs in a single request. Separate multiple file system IDs with commas (,).	extreme-233e6**,extreme-23vbp,extreme-23vas**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFilesystemType.NotSupport	The API operation does not support the file system type.	The API operation does not support the file system type.
403	InvalidAutoSnapshotPolicyId.NotFound	The specified auto snapshot policy does not exist in the region.	The specified automatic snapshot policy ID does not exist in the current region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.