Data Management：CLI整合樣本

前置概念

閱讀本文前，若您還不瞭解阿里雲CLI，請參見什麼是阿里雲CLI。

當您需要使用CLI調用API完成相對複雜的任務時，建議將CLI整理成Shell指令碼後再執行，以提高效率。

安裝阿里雲CLI

• 在Windows上安裝阿里雲CLI

• 在Linux上安裝阿里雲CLI

• 在macOS上安裝阿里雲CLI

您也可使用阿里雲提供的雲命令列Cloud Shell調試阿里雲CLI命令。關於雲命令列的更多資訊，請參見什麼是雲命令列？。

配置阿里雲CLI

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

1. 建立一個RAM使用者並授予管理對應產品的許可權。具體操作，請參見建立RAM使用者及為RAM使用者授權。需要授與權限：

   • AliyunDMSFullAccess：管理DMS資源的許可權。

   • （可選）AliyunCloudShellFullAccess：管理雲命令列（cloudshell）的許可權。

     說明

     如果您需要使用阿里雲提供的線上服務Cloud Shell，還需要添加AliyunCloudShellFullAccess許可權。

2. 建立RAM使用者並授權後，您需要建立RAM使用者對應的AccessKey，並記錄AccessKey ID和AccessKey Secret，以便後續配置身份憑證使用。具體操作，請參見建立AccessKey。

3. 配置憑證需要設定地區ID，阿里雲CLI將使用您指定的地區發起API調用。可用地區請參見服務存取點。

4. 使用RAM使用者的AccessKey配置AK類型憑證，設定檔命名為AkProfile。具體操作，請參見配置樣本。

產生CLI命令

1. 登入OpenAPI門戶。

2. 在API調試介面左側搜尋方塊中可搜尋您需要使用的API。

3. 在參數配置中根據API文檔資訊填寫參數，單擊參數配置右側的CLI樣本頁簽即可產生攜帶參數的命令樣本。

   

   • 單擊運行命令按鈕，快速完成命令調試。

   • 單擊複製按鈕，將CLI樣本複製到剪貼簿中，可粘貼至本地Shell工具中運行。

     說明

     • 將CLI樣本複製到本地Shell工具中進行調試時，請注意參數格式。關於阿里雲CLI命令參數使用格式的詳細資料，請參見參數格式說明。

     • 將命令複製到本地調用時，阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊，優先使用指定的地區調用命令，您可根據需要對該選項進行刪除或保留。OpenAPI門戶產生樣本中會預設添加--region選項。

調用樣本

以下程式碼範例將為您展示如何使用阿里雲CLI調用Data Management中的UpdateUser命令，更新指定使用者擁有的系統角色。擷取更多阿里雲CLI命令，請參見產生命令。

1. 執行命令。

   aliyun dms-enterprise UpdateUser --region cn-hangzhou --Uid 21400447956867**** --RoleNames 'ADMIN,DBA'

2. 輸出結果。

   {
           "RequestId": "B94173EF-0AEE-5B38-84A9-E6BDEF2B84F3",
           "Success": true
   }