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 | Query regions | Queries the available Alibaba Cloud regions. |
File systems
|
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 targets
|
API |
Title |
Description |
| CreateMountTarget | Create a mount target | Creates a mount target. |
| DeleteMountTarget | DeleteMountTarget | Deletes a mount target. |
| DescribeMountTargets | Query mount target information | Queries mount target information. |
Permission groups
|
API |
Title |
Description |
| DescribeAccessGroups | Query permission group information | Queries permission group information. |
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. |
Data flows
|
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 | Query data flows | Queries data flow information of a CPFS file system. |
| StopDataFlow | StopDataFlow | Disables a dataflow. |
| StartDataFlow | StartDataFlow | Enables a dataflow. |
| CreateDataFlowTask | Create a data flow task | Creates a data flow task. |
| CancelDataFlowTask | Cancel a data flow task | Cancels a data flow batch task or streaming task that is in the Pending or Executing state. |
| DescribeDataFlowTasks | Query data flow tasks | Queries the details of data flow tasks. |
| ApplyDataFlowAutoRefresh | Add auto-refresh configuration for a data flow | Configures automatic updates for a specified data flow. |
| CancelDataFlowAutoRefresh | CancelDataFlowAutoRefresh | Cancels the AutoRefresh configuration for a dataflow. |
| ModifyDataFlowAutoRefresh | Modify dataflow automatic update configuration | Modifies the automatic update configuration of a dataflow. |
Resource groups
|
API |
Title |
Description |
| ChangeResourceGroup | Change resource group | Changes the resource group to which a file system instance belongs. |
Protocol services
|
API |
Title |
Description |
| CreateProtocolService | Create a protocol service | Creates a protocol service for a Cloud Parallel File Storage (CPFS) file system. The creation process takes approximately 5 to 10 minutes. |
| DeleteProtocolService | DeleteProtocolService | Deletes a protocol service of a Cloud Parallel File Storage (CPFS) file system. |
| ModifyProtocolService | ModifyProtocolService | Modifies a protocol service. You can modify the description of a protocol service. |
| DescribeProtocolService | DescribeProtocolService | Queries the information about protocol services. |
| CreateProtocolMountTarget | Create a protocol service export directory | Creates an export directory for a protocol service. |
| DeleteProtocolMountTarget | DeleteProtocolMountTarget | Deletes an export directory of a protocol service. |
| ModifyProtocolMountTarget | ModifyProtocolMountTarget | Modifies the export directory parameters of a protocol service. Only the description can be modified. The virtual private cloud (VPC) ID and vSwitch ID cannot be changed. To change these IDs, you must delete the export directory and create a new one. |
| DescribeProtocolMountTarget | Query protocol service export directories | Queries the export directories of a protocol service. |
| GetProtocolMountTarget | GetProtocolMountTarget | Query the export directory information of the protocol service |