本文以調用大數據開發治理平臺 DataWorksListProjects
接口查詢DataWorks工作空間列表為例,為您介紹使用阿里云CLI調用DataWorks OpenAPI的操作步驟。
前置概念
阿里云CLI(Alibaba Cloud Command Line Interface)是基于OpenAPI構建的通用命令行工具,您可以通過阿里云CLI實現自動化管理和維護DataWorks。更多信息,請參見什么是阿里云CLI。
步驟一:安裝阿里云CLI
使用阿里云CLI前,您需要先安裝阿里云CLI。阿里云CLI為用戶提供了Windows、Linux和macOS三種操作系統下的安裝服務,請根據您使用設備的操作系統選擇對應的安裝服務。
Windows:在Windows上安裝阿里云CLI。
Linux:在Linux上安裝阿里云CLI。
macOS:在macOS上安裝阿里云CLI。
云命令行(Cloud Shell)中預裝了阿里云CLI,且自動為您配置身份憑證,無需手動操作。您可在云命令行中調試阿里云CLI命令。更多信息,請參見什么是云命令行。
步驟二:配置阿里云CLI
阿里云賬號(主賬號)擁有所有產品OpenAPI的管理和訪問權限,風險很高。強烈建議您創建RAM用戶(子賬號),并依據最小化權限原則授予權限,使用RAM用戶身份訪問OpenAPI。DataWorks支持的權限策略,請參見大數據開發治理平臺 DataWorks系統權限策略參考及DataWorks自定義權限策略參考。
使用阿里云CLI之前,您需要在阿里云CLI中配置身份憑證、地域ID等信息。阿里云CLI支持多種身份憑證,詳情請參見身份憑證類型。阿里云CLI支持使用RAM用戶的AccessKey信息配置AK類型身份憑證,具體操作步驟如下:
創建一個RAM用戶,并創建AccessKey,以便后續配置身份憑證使用。具體操作,請參見創建RAM用戶及創建AccessKey。
為RAM用戶授權。本文示例需授予RAM用戶只讀訪問DataWorks的權限
AliyunDataWorksReadOnlyAccess
。具體操作,請參見為RAM用戶授權。獲取可用的地域ID,以便后續配置身份憑證使用。阿里云CLI將使用您指定的地域發起OpenAPI調用。DataWorks的可用地域請參見服務接入點。
說明使用阿里云CLI過程中您可使用
--region
選項指定地域發起命令調用,該選項在使用時將忽略默認身份憑證配置及環境變量設置中的地域信息。詳情請參見API命令可用選項。使用RAM用戶的AccessKey配置AK類型憑證,配置文件命名為
AkProfile
。具體操作,請參見配置示例。
步驟三:生成CLI命令示例
在OpenAPI門戶中,訪問ListProjects調試地址。
在參數配置中輸入請求參數,單擊CLI示例頁簽,查看生成的CLI示例。
復制CLI示例或在云命令行中快速執行:
單擊運行命令按鈕,可喚出云命令行并快速完成命令調試。
單擊復制按鈕,將CLI示例復制到剪貼板中,可粘貼至本地Shell工具中運行或用于編輯自動化命令行腳本。
說明復制CLI示例到本地Shell工具中進行調試時請注意參數格式。關于阿里云CLI命令參數使用格式的詳細信息,請參見參數格式說明。
OpenAPI門戶生成示例中會默認添加
--region
選項,復制命令到本地調用時阿里云CLI將忽略默認身份憑證配置及環境變量設置中的地域信息,優先使用指定的地域調用命令,您可根據需要對該選項進行刪除或保留。
步驟四:調用DataWorks OpenAPI
示例一:獲取OpenAPI列表
以下示例將為您展示如何使用--help
選項獲取支持阿里云CLI調用的DataWorks OpenAPI列表。更多信息,請參見API概覽。
執行以下命令。
aliyun dataworks-public --help
預期輸出。
示例二:查詢工作空間列表
以下示例將為您展示如何使用阿里云CLI調用DataWorks的ListProjects
接口,查詢用戶所在租戶下運行正常的標準模式工作空間列表。更多接口信息,請參見ListProjects - 獲取工作空間詳情列表。
執行命令。
aliyun dataworks-public ListProjects --Status Available --DevEnvironmentEnabled true
輸出結果。
{ "RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4", "PagingInfo": { "PageSize": 1, "PageNumber": 10, "TotalCount": 1, "Projects": [ { "Id": 123456, "Name": "sora_finance", "DisplayName": "Sora金融分析", "Description": "金融分析組項目數據開發", "Owner": "12353215****", "AliyunResourceGroupId": "rg-acfmzbn7pti****", "Status": "Available", "PaiTaskEnabled": true, "DevEnvironmentEnabled": true, "DevRoleDisabled": false, "AliyunResourceTags": [ { "Key": "batch", "Value": "blue" } ] } ] } }
說明如果調用DataWorks OpenAPI后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。
您可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。