API overview
Updated at:
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. |
Region
|
API |
Title |
Description |
| DescribeZones | DescribeZones | Queries all zones in a region and the file system types that are supported in each zone. |
| DescribeRegions | Query regions | Queries the available Alibaba Cloud regions. |
File system
|
API |
Title |
Description |
| CreateFileSystem | Create a file system | Creates a file system. |
| DeleteFileSystem | DeleteFileSystem | Deletes a file system. |
| ModifyFileSystem | Modify file system description | 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 target
|
API |
Title |
Description |
| CreateMountTarget | Create a mount target | Creates a mount target. |
| DeleteMountTarget | DeleteMountTarget | Deletes a mount target. |
| ModifyMountTarget | Modify mount target information | Modifies mount target information. |
| DescribeMountTargets | Query mount target information | Queries mount target information. |
| DescribeMountedClients | DescribeMountedClients | Queries the clients on which a file system is mounted. |
Access point
|
API |
Title |
Description |
| CreateAccessPoint | Create an access point | Creates an access point. |
| ModifyAccessPoint | Modify access point information | Modifies access point information. |
| DescribeAccessPoints | Query access point information | Queries access point information. |
| DescribeAccessPoint | Query access point details | Queries the details of an access point. |
| DeleteAccessPoint | DeleteAccessPoint | Deletes an access point. |
| ListAccessPoints | Query access point information | Queries access point information. |
| CreateDir | CreateDir | Creates a directory in a file system. |
Permission group
|
API |
Title |
Description |
| CreateAccessGroup | Create a permission group | Creates a permission group. |
| DeleteAccessGroup | Delete access group | Delete an existing access group. |
| ModifyAccessGroup | Modify a permission group | 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 | Modify a permission group rule | Modifies a permission rule in a permission group. |
| DescribeAccessRules | Query permission rule description | Queries the description of a permission rule. |
Snapshot
|
API |
Title |
Description |
| CreateSnapshot | CreateSnapshot | Creates a snapshot. |
| DeleteSnapshot | Delete a snapshot or cancel a snapshot task that is being created | Deletes a specified snapshot or cancels a snapshot task that is being created. |
| DescribeSnapshots | Query snapshot list | Queries information about one or more snapshots of a specified file system. |
| CreateAutoSnapshotPolicy | Create an automatic snapshot policy | Creates an automatic snapshot policy. |
| DeleteAutoSnapshotPolicy | DeleteAutoSnapshotPolicy | Deletes an automatic snapshot policy. |
| ModifyAutoSnapshotPolicy | ModifyAutoSnapshotPolicy | An automatic snapshot policy is modified. After you modify an automatic snapshot policy that is applied to a file system, the modification immediately applies to subsequent snapshots that are created for the file system. |
| ApplyAutoSnapshotPolicy | Apply an automatic snapshot policy to file systems | Applies an automatic snapshot policy to one or more file systems. |
| CancelAutoSnapshotPolicy | Cancel the automatic snapshot policy for one or more file systems | Cancels the automatic snapshot policy that is created for a file system. |
| DescribeAutoSnapshotPolicies | Query created automatic snapshot policies | Queries the automatic snapshot policies that have been created. |
| DescribeAutoSnapshotTasks | Query automatic snapshot tasks | Queries the list of automatic snapshot tasks. |
| ResetFileSystem | Roll back a file system to a snapshot | Rolls back a file system to the state of a specified historical snapshot. |
Tag
|
API |
Title |
Description |
| TagResources | TagResources | Creates tags and binds the tags to file systems. |
| UntagResources | UntagResources | Removes tags from a file system. |
| ListTagResources | ListTagResources | Queries tags. |
Quota
|
API |
Title |
Description |
| SetDirQuota | Set a directory quota for a file system | Sets a directory quota for a file system. |
| CancelDirQuota | Cancel a directory quota for a file system | Cancels a directory quota for a file system. |
| DescribeDirQuotas | DescribeDirQuotas | Queries the directory quotas of a file system. |
Lifecycle management
|
API |
Title |
Description |
| CreateLifecyclePolicy | Create a lifecycle management policy | Creates a lifecycle management policy. |
| UpdateLifecyclePolicy | Update the rules of a lifecycle management policy | Updates the rules of a lifecycle management policy. Only CPFS for Lingjun is supported. UpdateLifecyclePolicy uses overwrite semantics. If an optional parameter is left empty, the corresponding field is deleted. To append lifecycle rules, first call the DescribeLifecyclePolicies operation to obtain the current lifecycle rule configurations, append the new lifecycle rule configurations, and then call the UpdateLifecyclePolicy operation to update the lifecycle rule configurations. |
| DeleteLifecyclePolicy | DeleteLifecyclePolicy | Deletes a lifecycle policy. |
| ModifyLifecyclePolicy | Modify a lifecycle management policy | Modifies a lifecycle management 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 the list of lifecycle management policies. |
| CreateLifecycleRetrieveJob | Create a data retrieval task | Creates a data retrieval task. |
| CancelLifecycleRetrieveJob | CancelLifecycleRetrieveJob | Cancels a running data retrieval task. |
| RetryLifecycleRetrieveJob | RetryLifecycleRetrieveJob | Retries failed a data retrieval task. |
| StartLifecyclePolicyExecution | StartLifecyclePolicyExecution | Starts the execution of a lifecycle policy. |
| StopLifecyclePolicyExecution | Stop executing a lifecycle policy | Stops the execution of a lifecycle policy. |
| DescribeLifecyclePolicyLogs | Query execution logs of a lifecycle policy | Queries the execution logs of a lifecycle policy. You can query logs from the last 90 days or up to 1000 log entries. Only CPFS for Lingjun is supported. |
| ListLifecycleRetrieveJobs | Query data retrieval task list | Retrieves the list of created data retrieval tasks. |
| ListDirectoriesAndFiles | Query directory and file list | Retrieves the list of IA storage class files and subdirectories that contain IA storage class files under a specified directory in a General-purpose NAS file system. |
Recycle bin
|
API |
Title |
Description |
| EnableRecycleBin | EnableRecycleBin | Enables the recycle bin feature for a file system. |
| DisableAndCleanRecycleBin | DisableAndCleanRecycleBin | Disables and empties the recycle bin of a General-purpose NAS file system. |
| UpdateRecycleBinAttribute | UpdateRecycleBinAttribute | Modifies the retention period of data in the recycle bin of a file system. |
| GetRecycleBinAttribute | Get recycle bin attributes | Queries the recycle bin configuration of a specified General-purpose NAS file system. |
| CreateRecycleBinRestoreJob | CreateRecycleBinRestoreJob | Restores a file or directory from the recycle bin. |
| CreateRecycleBinDeleteJob | Permanently delete a file or directory from the recycle bin | Creates a task to permanently delete a file or directory from the recycle bin. |
| CancelRecycleBinJob | CancelRecycleBinJob | Cancels a running job of the recycle bin. |
| ListRecycleBinJobs | Query tasks in the recycle bin | Queries information about one or more tasks in the recycle bin. |
| ListRecentlyRecycledDirectories | Query recently deleted directories | Queries directories on which delete operations were recently performed. |
| ListRecycledDirectoriesAndFiles | Query deleted files or directories | Queries deleted files or directories. |
AgenticSpace
|
API |
Title |
Description |
| CreateAgenticSpace | Create an agentic space | Creates an Agentic space. |
| ModifyAgenticSpace | Modify an agentic space | Modifies an Agentic space. |
| GetAgenticSpace | Query an agentic space | Queries an Agentic space. |
| DeleteAgenticSpace | Delete an agentic space | Deletes an Agentic space. |
| SetAgenticSpaceQuota | Set agenticSpace quota | Sets the quota for an Agentic space. |
| DescribeAgenticSpaces | Query agenticSpace | Queries Agentic spaces. |
SMB AD ACL
|
API |
Title |
Description |
| EnableSmbAcl | Enable SMB AD ACL | Enables the SMB AD ACL feature. |
| DisableSmbAcl | Disable SMB AD ACL | Disables the SMB AD ACL feature. |
| ModifySmbAcl | Update SMB AD ACL | Updates the SMB AD ACL feature. |
| DescribeSmbAcl | Query SMB AD ACL | Queries the SMB AD ACL feature. |
| CreateFile | CreateFile | Creates a directory or file. |
NFS NAS ACL
|
API |
Title |
Description |
| EnableNfsAcl | EnableNfsAcl | Enables the NFS ACL feature for a file system. |
| DisableNfsAcl | DisableNfsAcl | Disables the NFS ACL feature for a file system. |
| DescribeNfsAcl | DescribeNfsAcl | Queries whether the NFS ACL feature is enabled for a file system. |
Log management
|
API |
Title |
Description |
| CreateLogAnalysis | CreateLogAnalysis | Dumps the logs of a General-purpose NAS file system to Simple Log Service. |
| DeleteLogAnalysis | DeleteLogAnalysis | Disables log dumping for a General-purpose NAS file system. |
| DescribeLogAnalysis | Retrieve log analysis information | Lists the log analysis configurations in log analysis. |
Resource group
|
API |
Title |
Description |
| ChangeResourceGroup | Change resource group | Changes the resource group to which a file system instance belongs. |
Virtual storage channel
|
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 Virtual Storage Channel (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. |
Is this page helpful?