File Storage NAS:CLI integration example

Background information

For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI

Install Alibaba Cloud CLI

You must install Alibaba Cloud CLI before you can use Alibaba Cloud CLI. You can install Alibaba Cloud CLI on the Windows, Linux, and macOS operating systems. Select an installation package of Alibaba Cloud CLI based on the operating system of your device. For more information, see the following topics:

• Install Alibaba Cloud CLI on Windows

• Install Alibaba Cloud CLI on Linux

• Install Alibaba Cloud CLI on macOS

You can also use Cloud Shell provided by Alibaba Cloud to debug the commands that you want to run in Alibaba Cloud CLI. For more information about Cloud Shell, see What is Cloud Shell?

Configure Alibaba Cloud CLI

Before you use Alibaba Cloud CLI, you must configure credential information such as identity credentials and a region ID in Alibaba Cloud CLI. Alibaba Cloud CLI supports various identity credentials. For more information, see Identity credential types. In this example, AccessKey credentials are used. Perform the following steps:

1. Create a RAM user and grant the permissions to manage Alibaba Cloud services based on your business requirements. For more information, see Create a RAM user and Manage RAM user permissions.

2. Create an AccessKey pair for the RAM user and record the AccessKey ID and AccessKey secret for the subsequent configuration of identity credentials. For more information, see Create an AccessKey.

3. Specify a region ID. Alibaba Cloud CLI calls API operations in the specified region. For more information about available regions, see Endpoints.

4. Use the AccessKey pair of the RAM user to configure identity credentials in the configuration file named AkProfile. For more information, see Configure and manage credentials.

Generate a CLI command

1. Log on to the OpenAPI Portal.

2. On the API debugging page, you can search for the API that you want to use in the search box on the left. In the Parameter Configuration section, enter the parameters according to the API documentation, and then click the CLI Example tab to the right of Parameter Configuration to generate a command example with the parameters.

   • Click Run Command to open Cloud Shell and quickly debug the command.

   • Click Copy to copy the command example to your clipboard. You can then paste it into your local shell tool to run it.

     • Pay attention to the parameter formats when you copy and paste the CLI command to the local shell. For more information about the parameter formats of Alibaba Cloud CLI, see Understand command parameters.

     • By default, the --region option is added to the sample command that is generated in OpenAPI Explorer. When you copy the command to your shell tool, Alibaba Cloud CLI ignores the region information in the default credential configurations and environment variable settings, and preferentially runs the command in the specified region. You can delete or retain this option based on your business requirements.

Use Alibaba Cloud CLI to call NAS API operations

Syntax

In Alibaba Cloud CLI, you can use the following syntax to run commands. For more information, see Generate and run CLI commands with OpenAPI Explorer.

aliyun <command> <subcommand> [options and parameters]

Command options

Examples

• Example 1: Use Alibaba Cloud CLI to call the CreateFileSystem operation of NAS to create a pay-as-you-go General-purpose Capacity Network File System (NFS) file system.

  1. Run the following command:

     aliyun nas CreateFileSystem --FileSystemType standard --ChargeType PayAsYouGo --StorageType Capacity --ProtocolType NFS

  2. View the command output.

     {
             "FileSystemId": "6a2464****",
             "RequestId": "3879AB9C-1DED-5A49-A015-350138B23BF0"
     }

• Example 2: Use Alibaba Cloud CLI to call the CreateAccessGroup operation of NAS to create a permission group named vpc_test.

  1. Run the following command:

     aliyun nas CreateAccessGroup --AccessGroupName vpc_test --AccessGroupType Vpc

  2. View the command output.

     {
             "AccessGroupName": "vpc_test",
             "RequestId": "95CB3005-C251-5E11-A949-29CB2C7A9C54"
     }