背景信息

閱讀本文前，若您還不了解阿里云CLI，請參見什么是阿里云CLI。

安裝阿里云CLI

使用阿里云CLI前，您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統(tǒng)下的安裝服務(wù)，請根據(jù)您使用設(shè)備的操作系統(tǒng)選擇對應(yīng)的安裝服務(wù)。

• 在Windows上安裝阿里云CLI

• 在Linux上安裝阿里云CLI

• 在macOS上安裝阿里云CLI

您也可使用阿里云提供的云命令行Cloud Shell調(diào)試阿里云CLI命令。關(guān)于云命令行的更多信息，請參見什么是云命令行。

配置阿里云CLI

使用阿里云CLI之前，您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證，詳情請參見身份憑證類型。本文操作以AK類型憑證為例，具體操作步驟如下：

1. 您需要創(chuàng)建一個RAM用戶并根據(jù)需要授予管理對應(yīng)產(chǎn)品的權(quán)限。具體操作，請參見創(chuàng)建RAM用戶及為RAM用戶授權(quán)。

2. 創(chuàng)建RAM用戶并授權(quán)后，您需要創(chuàng)建RAM用戶對應(yīng)的AccessKey，并記錄AccessKey ID和AccessKey Secret，以便后續(xù)配置身份憑證使用。具體操作，請參見創(chuàng)建AccessKey。

3. 配置憑證需要設(shè)置地域ID，阿里云CLI將使用您指定的地域發(fā)起API調(diào)用。可用地域請參見服務(wù)接入點(diǎn)。

   說明

   使用阿里云CLI過程中您可使用--region選項(xiàng)指定地域發(fā)起命令調(diào)用，該選項(xiàng)在使用時(shí)將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息。詳情請參見API命令可用選項(xiàng)。

4. 使用RAM用戶的AccessKey配置AK類型憑證，配置文件命名為AkProfile。具體操作，請參見配置示例。

生成CLI命令示例

1. 登錄文件存儲NAS調(diào)試列表。

2. 在API調(diào)試界面左側(cè)搜索框中可搜索您需要使用的API。在參數(shù)配置中根據(jù)API文檔信息填寫參數(shù)，單擊參數(shù)配置右側(cè)的CLI示例頁簽即可生成攜帶參數(shù)的命令示例。

   

   • 單擊運(yùn)行命令按鈕，可喚出云命令行并快速完成命令調(diào)試。

   • 單擊復(fù)制按鈕，將CLI示例復(fù)制到剪貼板中，可粘貼至本地Shell工具中運(yùn)行。

     • 復(fù)制CLI示例到本地Shell工具中進(jìn)行調(diào)試時(shí)請注意參數(shù)格式。關(guān)于阿里云CLI命令參數(shù)使用格式的詳細(xì)信息，請參見參數(shù)格式說明。

     • OpenAPI門戶生成示例中會默認(rèn)添加--region選項(xiàng)，復(fù)制命令到本地調(diào)用時(shí)阿里云CLI將忽略默認(rèn)身份憑證配置及環(huán)境變量設(shè)置中的地域信息，優(yōu)先使用指定的地域調(diào)用命令，您可根據(jù)需要對該選項(xiàng)進(jìn)行刪除或保留。

使用CLI調(diào)用NAS API

命令結(jié)構(gòu)

阿里云CLI的通用命令行結(jié)構(gòu)如下。更多詳情，請參見命令結(jié)構(gòu)。

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

常用命令選項(xiàng)

調(diào)用示例

• 示例一：以下示例將為您展示如何使用阿里云CLI調(diào)用文件存儲NAS中的CreateFileSystem命令，創(chuàng)建一個按量付費(fèi)的通用容量型NAS NFS協(xié)議文件系統(tǒng)。

  1. 執(zhí)行命令。

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

  2. 輸出結(jié)果。

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

• 示例二：以下示例將為您展示如何使用阿里云CLI調(diào)用文件存儲NAS中的CreateAccessGroup命令，創(chuàng)建一個權(quán)限組vpc_test。

  1. 執(zhí)行命令。

     aliyun nas CreateAccessGroup --AccessGroupName vpc_test --AccessGroupType Vpc

  2. 輸出結(jié)果。

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

• 示例三：以下代碼示例將為您展示如何使用--help選項(xiàng)獲取文件存儲NAS支持阿里云CLI調(diào)用API列表。您也可以在API概覽中查看支持調(diào)用的API。

  1. 執(zhí)行命令。

     aliyun nas --help

  2. 輸出結(jié)果。