Overview of NAS API operation integration - Apsara File Storage NAS

This topic describes the API integration solution provided by Apsara File Storage NAS (NAS).

API integration

NAS provides API operations for you to manage file systems, permission groups, mount targets, lifecycle policies, and snapshots. You can integrate API operations in your business system. For more information about how to call API operations in OpenAPI Explorer, see Call API operations.

Version description

Version	Description
2017-06-26	Recommended.

Endpoints

The endpoints for NAS are related to regions. For more information about the supported endpoints, see Endpoints.

User identities

User identity	Supported or not
Alibaba Cloud account	Yes
RAM user(recommended)	Yes
RAM role(recommended)	Yes

We recommend that you use a RAM user or RAM role to call API operations. Before you use a RAM user or RAM role to call API operations, you must grant required permissions to the RAM user or RAM role.

API styles

The remote procedure call (RPC) style is used. The API style determines the calling methods of API operations. For more information, see API styles.

Calling methods

Calling method	Supported or not	References
Alibaba Cloud SDKs (recommended)	Yes	For more information about the programming languages supported by NAS, see Apsara File Storage NAS SDKs. For more information about how to use Alibaba Cloud SDKs to call API operations, see Alibaba Cloud SDKs.
Alibaba Cloud Command Line Interface (CLI)	Yes	For more information about how to use Alibaba Cloud CLI to call API operations, see Alibaba Cloud CLI.
Resource Orchestration Service (ROS)	Yes	For more information about how to use ROS to automatically create and configure resources, see What is ROS? For more information about the NAS resource types supported by ROS, see ROS.
Terraform	Yes	For more information about how to use Terraform to automatically create and manage resources, see What is Terraform? For more information about the NAS resource types supported by Terraform, see Terraform.
Custom encapsulation (not recommended)	Yes	You must encapsulate requests based on your business requirements. For more information, see Custom encapsulation.

Precautions

If an error is returned after you call an API operation, you must check whether the request parameters and values are valid based on the returned error code. For a list of error codes, see Service error codes.
You can also visit OpenAPI Errors Troubleshooting to perform self-service diagnostics based on the returned request ID or SDK error information.

ROS

The following table lists the NAS resource types supported by ROS.

Cloud service	Resource type
NAS	ALIYUN::NAS::AccessGroup: creates a permission group. ALIYUN::NAS::AccessRule: creates a rule for a permission group. ALIYUN::NAS::FileSystem: create a NAS file system. ALIYUN::NAS::MountTarget: creates a mount target. DATASOURCE::NAS::AccessGroups: queries the details of permission groups. DATASOURCE::NAS::FileSystems: queries the details of file systems. DATASOURCE::NAS::Zones: queries zones.

Terraform

The following table lists the NAS resource types supported by Terraform.

Cloud service

Resource type

NAS

alicloud_nas_access_group: provides a permission group.
alicloud_nas_access_rule: provides an access rule.
alicloud_nas_file_system: creates a file system.
alicloud_nas_mount_target: provides a mount target.
alicloud_nas_snapshot: provides a snapshot for an Extreme NAS file system.
alicloud_nas_auto_snapshot_policy: provides an auto snapshot policy for an Extreme NAS file system.
alicloud_nas_lifecycle_policy: provides a lifecycle policy.
alicloud_nas_recycle_bin: provides the recycle bin feature.
alicloud_nas_smb_acl_attachment: provides the access control list (ACL) feature for a Server Message Block (SMB) file system that resides in an AD domain.