如何安裝、初始化配置和使用雲效 CLI - Alibaba Cloud DevOps

通過阿里雲 CLI（Alibaba Cloud Command Line Interface）調用雲效 OpenAPI，可以通過命令列管理和維護代碼管理 Codeup、流水線 Flow、專案協作 Projex、應用交付 AppStack 等子產品，實現 DevOps 流程的自動化。以下以調用 flow-get-flow-tag-group 介面擷取流水線標籤組詳情為例，介紹從安裝、配置到首次 API 呼叫的完整流程。

開始之前

已建立雲效組織，並確認組織類型為 Region 版。關於組織類型的差異和接入方式，參見服務存取點。
已擷取個人存取權杖（Personal Access Token）。擷取方式參見擷取個人存取權杖。
已瞭解阿里雲 CLI 的基本概念，參見什麼是阿里雲 CLI。

步驟一：安裝阿里雲 CLI

根據作業系統選擇對應的安裝方式：

也可使用阿里雲提供的雲命令列 Cloud Shell 調試 CLI 命令，參見什麼是雲命令列。

步驟二：配置雲效 CLI

重要

雲效（Yunxiao）的資料面帳號體系與阿里雲其他產品不同，不使用 profile（AK/SK）儲存身份憑證，而是通過個人存取權杖（Personal Access Token） 進行認證。需要先在雲效控制台產生個人存取權杖，再通過環境變數或命令列參數傳入，而非使用 aliyun configure 配置 profile。

擷取個人存取權杖

個人存取權杖可用於訪問雲效 API 及通過 HTTP 協議進行 Git 操作。

警告

建立令牌時，請選擇最小授權範圍的 API 許可權點，並設定合理的有效時間，避免使用永久令牌。
令牌僅在首次建立時顯示，後續無法再次查看，請務必妥善儲存。
請勿通過命令列以純文字形式傳遞令牌，建議通過環境變數傳入。
發現令牌泄露時，請立即刪除。

配置身份憑證

雲效 CLI 支援兩種配置方式：環境變數和命令列參數。

方式一：通過環境變數配置（推薦）

雲效 CLI 使用以下環境變數完成身份和存取點配置：

環境變數	說明	Region 版
`ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN`	雲效個人存取權杖	必須
`ALIBABA_CLOUD_YUNXIAO_API_BASE_URL`	API 接入地址	必須
`ALIBABA_CLOUD_YUNXIAO_ORGANIZATION_ID`	組織 ID	不需要

Region 版樣本：

export ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN=<your-personal-access-token>
export ALIBABA_CLOUD_YUNXIAO_API_BASE_URL=<your-api-base-url>

方式二：通過命令列參數配置

不設定環境變數時，每條命令也支援直接通過參數傳入：

參數	說明	Region 版
`--yunxiao-access-token`	雲效個人存取權杖（對應環境變數：`ALIBABA_CLOUD_YUNXIAO_ACCESS_TOKEN`）	必須
`--api-base-url`	API 接入地址（對應環境變數：`ALIBABA_CLOUD_YUNXIAO_API_BASE_URL`）	必須
`--organization-id`	組織 ID（對應環境變數：`ALIBABA_CLOUD_YUNXIAO_ORGANIZATION_ID`）	不需要

Region 版樣本：

aliyun devops flow-get-flow-tag-group --id 0 \
  --api-base-url=<your-api-base-url> \
  --yunxiao-access-token=<your-personal-access-token>

驗證配置

完成配置後，執行以下命令確認雲效 CLI 外掛程式已正確載入：

aliyun devops version

命令成功執行並返回版本資訊，表示 CLI 安裝和外掛程式載入正常。

步驟三：調用雲效 API

樣本一：查看支援的 OpenAPI 列表

使用 --help 選項查看雲效 CLI 支援的全部命令列表。

執行命令

aliyun devops --help

輸出結果（部分）

Description: Aliyun CLI plugin for yunxiao operations.

Usage: aliyun devops <command> [flags]

Available Commands:
  app-stack-create-application        建立應用
  app-stack-list-applications         擷取應用列表
  codeup-create-repository            建立代碼倉庫
  codeup-list-repositories            擷取代碼倉庫列表
  flow-create-pipeline                建立流水線
  flow-list-pipelines                 擷取流水線列表
  flow-get-flow-tag-group             擷取流水線標籤組詳情
  projex-search-projects              搜尋專案
  projex-search-workitems             搜尋工作項目
  ...

雲效 CLI 覆蓋以下主要模組：

模組首碼	功能說明
`app-stack-*`	應用交付（AppStack）
`base-*`	基礎資訊（組織、成員、角色等）
`codeup-*`	代碼管理（Codeup）
`flow-*`	流水線（Flow）
`insight-*`	效能洞察（Insight）
`packages-*`	製品倉庫（Packages）
`projex-*`	專案協作（Projex）
`test-hub-*`	測試管理（Testhub）

樣本二：擷取流水線標籤組詳情

以下樣本展示如何調用 flow-get-flow-tag-group 命令擷取流水線標籤組詳情。