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. |
Filesets
|
API |
Title |
Description |
| CreateFileset | CreateFileset | Creates a fileset. |
| DeleteFileset | Delete a fileset | Deletes a fileset. |
| ModifyFileset | ModifyFileset | Modifies a fileset. |
| GetFileset | GetFileset | Queries the information about the created fileset. |
| DescribeFilesets | Query filesets | Queries the list of created filesets. |
| SetFilesetQuota | SetFilesetQuota | Sets the quota for a fileset. |
Data flow
|
API |
Title |
Description |
| CreateDataFlow | Create a data flow | Creates a data flow between a CPFS General-purpose or CPFS for Lingjun file system and source storage. |
| DeleteDataFlow | DeleteDataFlow | Deletes a dataflow. |
| ModifyDataFlow | Modify a data flow | Modifies the attributes of a data flow. |
| DescribeDataFlows | DescribeDataFlows | Queries the dataflows of a CPFS file system. |
| CreateDataFlowTask | CreateDataFlowTask | Create a data flow task. |
| CreateDataFlowSubTask | CreateDataFlowSubTask | Creates a data streaming subtask. |
| CancelDataFlowTask | CancelDataFlowTask | Cancels a batch or streaming data flow task that is in the Pending or Executing state. |
| DescribeDataFlowTasks | DescribeDataFlowTasks | Retrieves data flow task details. |
| DescribeDataFlowSubTasks | DescribeDataFlowSubTasks | Queries data flow subtasks in batches. |
Resource groups
|
API |
Title |
Description |
| ChangeResourceGroup | Change resource group | Changes the resource group to which a file system instance belongs. |
Virtual storage channels
|
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. |