API standards and multilingual preset SDKs
The OpenAPI of this product (NAS/2017-06-26) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service operations
|
API |
Title |
Description |
| OpenNASService | OpenNASService | Activates the NAS service. |
Regions
|
API |
Title |
Description |
| DescribeZones | DescribeZones | Queries all zones in a region and the file system types that are supported in each zone. |
| DescribeRegions | DescribeRegions | Queries the regions in which File Storage NAS is available. |
File systems
|
API |
Title |
Description |
| CreateFileSystem | CreateFileSystem | Creates a file system. |
| DeleteFileSystem | DeleteFileSystem | Deletes a file system. |
| ModifyFileSystem | ModifyFileSystem | Modifies the description of a file system. |
| DescribeFileSystems | Query file system information | Queries file system information. |
| UpgradeFileSystem | UpgradeFileSystem | Scales up an Extreme NAS file system or a Cloud Parallel File Storage (CPFS) file system. |
| DescribeFilesystemsAssociatedHpnZones | DescribeFilesystemsAssociatedHpnZones | Retrieves the list of HpnZones for a file system. Access performance is optimal when compute nodes are located in one of the associated HpnZones. |
Mount targets
|
API |
Title |
Description |
| CreateMountTarget | Create a mount target | Creates a mount target. |
| DeleteMountTarget | DeleteMountTarget | Deletes a mount target. |
| ModifyMountTarget | ModifyMountTarget | Modifies the properties of a mount target. |
| DescribeMountTargets | DescribeMountTargets | Retrieves information about mount targets. |
| DescribeMountedClients | DescribeMountedClients | Queries the clients on which a file system is mounted. |
Access points
|
API |
Title |
Description |
| CreateAccessPoint | Create an access point | Creates an access point. |
| DescribeAccessPoints | Query access point information | Queries access point information. |
| DescribeAccessPoint | Query access point details | Queries the details of an access point. |
Permission groups
|
API |
Title |
Description |
| CreateAccessGroup | Create a permission group | Creates a permission group. |
| DeleteAccessGroup | Delete access group | Delete an existing access group. |
| ModifyAccessGroup | ModifyAccessGroup | Modifies a permission group. |
| DescribeAccessGroups | Query permission group information | Queries permission group information. |
| CreateAccessRule | Create a permission rule | Creates a permission rule for a permission group. |
| DeleteAccessRule | Delete a permission rule | Deletes a permission rule from a permission group. |
| ModifyAccessRule | ModifyAccessRule | Modifies a rule in a permission group. |
| DescribeAccessRules | DescribeAccessRules | Queries the information about rules in a permission group. |
Snapshots
|
API |
Title |
Description |
| TagResources | TagResources | Creates tags and binds the tags to file systems. |
| ListTagResources | ListTagResources | Queries tags. |
Tags
|
API |
Title |
Description |
| CreateLifecyclePolicy | CreateLifecyclePolicy | Creates a lifecycle policy. |
| UpdateLifecyclePolicy | UpdateLifecyclePolicy | Updates the rules of a lifecycle policy. This operation is supported only for CPFS for AI file systems. The `UpdateLifecyclePolicy` operation overwrites the entire policy. Omitting an optional parameter deletes its corresponding configuration. To add a rule to an existing policy, call the `DescribeLifecyclePolicies` operation to retrieve the current policy, append the new rule, and then call `UpdateLifecyclePolicy` with the updated configuration. |
| DeleteLifecyclePolicy | DeleteLifecyclePolicy | Deletes a lifecycle policy. |
| ModifyLifecyclePolicy | ModifyLifecyclePolicy | Modifies a lifecycle policy. |
| GetDirectoryOrFileProperties | GetDirectoryOrFileProperties | Checks if a specified directory contains infrequent access or archive storage files, or if a specified file is an infrequent access or archive storage file. |
| DescribeLifecyclePolicies | Query lifecycle management policies | Retrieves a list of lifecycle management policies. |
| StartLifecyclePolicyExecution | StartLifecyclePolicyExecution | Starts the execution of a lifecycle policy. |
| StopLifecyclePolicyExecution | StopLifecyclePolicyExecution | Stops the execution of a lifecycle policy. |
| DescribeLifecyclePolicyLogs | DescribeLifecyclePolicyLogs | Queries the execution logs of a lifecycle policy, returning up to 1,000 entries from the last 90 days. This feature is only available for CPFS AI Computing Edition. |
| ListDirectoriesAndFiles | ListDirectoriesAndFiles | Lists Infrequent Access files and the subdirectories that contain them from a specified directory on a General-purpose NAS file system. |
Quotas
|
API |
Title |
Description |
| CreateRecycleBinRestoreJob | CreateRecycleBinRestoreJob | Restores a file or directory from the recycle bin. |
| CreateRecycleBinDeleteJob | CreateRecycleBinDeleteJob | Creates a job to permanently delete a file or directory from the recycle bin. |
Lifecycle management
|
API |
Title |
Description |
| ChangeResourceGroup | Change resource group | Changes the resource group to which a file system instance belongs. |
Recycle bin
|
API |
Title |
Description |
| DetachVscFromFilesystems | Dissociate a VSC device from a file system | Dissociates a VSC device from a file system. |
| AttachVscToFilesystems | Associate a VSC device with a file system | Associates a VSC device with a file system. |
| DescribeFilesystemsVscAttachInfo | Query virtual storage channel information associated with a file system | Queries the virtual storage channel information associated with a file system. |