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. |
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 | DescribeFileSystems | Queries file systems. |
| UpgradeFileSystem | UpgradeFileSystem | Scales up an Extreme NAS file system or a Cloud Parallel File Storage (CPFS) file system. |
Mount targets
| API | Title | Description |
|---|---|---|
| CreateMountTarget | CreateMountTarget | Creates a mount target. |
| DeleteMountTarget | DeleteMountTarget | Deletes a mount target. |
| DescribeMountTargets | DescribeMountTargets | Queries mount targets. |
Permission groups
| API | Title | Description |
|---|---|---|
| DescribeAccessGroups | DescribeAccessGroups | Queries permission groups. |
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. |
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. |
| StopDataFlow | StopDataFlow | Disables a dataflow. |
| StartDataFlow | StartDataFlow | Enables a dataflow. |
| CreateDataFlowTask | CreateDataFlowTask | Creates a dataflow task. |
| CancelDataFlowTask | CancelDataFlowTask | Cancels a batch or streaming task that is in the Pending or Execute state. |
| DescribeDataFlowTasks | DescribeDataFlowTasks | Queries the details of dataflow tasks. |
| ApplyDataFlowAutoRefresh | ApplyDataFlowAutoRefresh | Adds AutoRefresh configurations to a dataflow. |
| CancelDataFlowAutoRefresh | CancelDataFlowAutoRefresh | Cancels the AutoRefresh configuration for a dataflow. |
| ModifyDataFlowAutoRefresh | ModifyDataFlowAutoRefresh | Modifies an AutoRefresh configuration of a dataflow. |
Resource group
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a file system belongs. |
Protocol service
| API | Title | Description |
|---|---|---|
| CreateProtocolService | CreateProtocolService | Creates a protocol service for a Cloud Parallel File Storage (CPFS) file system. The creation takes about 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 | CreateProtocolMountTarget | 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 | DescribeProtocolMountTarget | Queries the export directories of a protocol service. |
| 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. |
其他-不发布文档
| API | Title | Description |
|---|---|---|
| LDAP | LDAP | |
| CreateLDAPConfig | CreateLDAPConfig | Creates LDAP configurations. |
| DeleteLDAPConfig | {"title1":"DeleteLDAPConfig"} | {"summary1":""} |