API standard and pre-built SDKs in multi-language
This product (NAS/2017-06-26) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Open service
| API | Title | Description |
|---|---|---|
| OpenNASService | OpenNASService | Activates File Storage NAS. |
File systems
| API | Title | Description |
|---|---|---|
| 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. |
Fileset
| API | Title | Description |
|---|---|---|
| CreateFileset | CreateFileset | Creates a fileset. |
| DeleteFileset | DeleteFileset | Deletes a fileset. |
| ModifyFileset | ModifyFileset | Modifies a fileset. |
| GetFileset | GetFileset | Queries the information about the created fileset. |
| DescribeFilesets | DescribeFilesets | Queries the information about created filesets. |
| SetFilesetQuota | SetFilesetQuota | Sets the quota for a fileset. |
| CancelFilesetQuota | CancelFilesetQuota | Cancels the quota set for a fileset. |
Data flows
| API | Title | Description |
|---|---|---|
| CreateDataFlow | CreateDataFlow | Creates a dataflow for a Cloud Parallel File Storage (CPFS) file system and source storage. |
| DeleteDataFlow | DeleteDataFlow | Deletes a dataflow. |
| ModifyDataFlow | ModifyDataFlow | Modifies the attributes of a dataflow. |
| DescribeDataFlows | DescribeDataFlows | Queries the dataflows of a CPFS file system. |
| CreateDataFlowTask | CreateDataFlowTask | Creates a dataflow task. |
| CreateDataFlowSubTask | CreateDataFlowSubTask | Creates a data streaming subtask. |
| CancelDataFlowTask | CancelDataFlowTask | Cancels a batch or streaming task that is in the Pending or Execute state. |
| CancelDataFlowSubTask | CancelDataFlowSubTask | Cancels a data streaming task. |
| DescribeDataFlowTasks | DescribeDataFlowTasks | Queries the details of dataflow tasks. |
| DescribeDataFlowSubTasks | DescribeDataFlowSubTasks | Queries data flow subtasks in batches. |
Resource group
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a file system belongs. |
Protocol service
| API | Title | Description |
|---|---|---|
| GetProtocolMountTarget | GetProtocolMountTarget | Query the export directory information of the protocol service |
Virtual Storage Channel
| API | Title | Description |
|---|---|---|
| DetachVscFromFilesystems | DetachVscFromFilesystems | Unassociates a VSC device from a file system. |
| AttachVscToFilesystems | AttachVscToFilesystems | Associates the VSC device with the file system. |
| DescribeFilesystemsVscAttachInfo | DescribeFilesystemsVscAttachInfo | Queries information about virtual storage channels associated with a file system. |