阿里雲CLI採用外掛程式化命令結構，支援通過`--help`查看命令協助，推薦使用3.3.0及以上版本以實現自動外掛程式載入和命令遷移。 - Alibaba Cloud CLI

阿里雲 CLI 採用統一的外掛程式化命令結構。本文介紹命令各組成部分的含義，以及如何通過 --help 快速查看可用命令和參數。

前提條件

已安裝阿里雲 CLI 3.3.0 或更高版本。安裝方法，請參見安裝/更新 CLI。
確保阿里雲 CLI 已配置憑證。配置方法，請參見配置與管理身份憑證。

命令格式

外掛程式版CLI命令格式

外掛程式版阿里雲 CLI 的通用命令結構如下：

aliyun <command> <sub-command> [parameters]

各部分說明：

command：頂級命令，可以是以下兩類：
- 全域命令（無需安裝外掛程式）。例如：
  - configure（配置憑證和預設參數）。
  - plugin（管理外掛程式）。
  - upgrade（升級 CLI 主程式）。
  所有全域命令可通過 aliyun --help 查看。
- 雲產品外掛程式名。例如 aliyun-cli-ecs、aliyun-cli-oss、aliyun-cli-cs、aliyun-cli-fc 等。
sub-command：子命令（SubCommand），指定要執行的具體操作。
- 當頂級命令為全域命令時，可通過 aliyun <command> --help 查看具體參數或子命令。
- 當頂級命令為雲產品外掛程式時，子命令採用 kebab-case 命名。例如 describe-instances、create-bucket。
parameters：命令參數，用於控制阿里雲 CLI 的行為或指定 API 參數。更多參數格式資訊，請參見理解命令列參數。
- 業務參數：以 -- 開頭，例如 --instance-id i-xxx。
- 全域參數：影響整個命令列為的通用參數，例如 --region cn-hangzhou、--profile prod等。

最小可執行樣本

以下命令查詢當前帳號可訪問的地區列表，無需額外參數即可執行：

aliyun ecs describe-regions

外掛程式按需載入

CLI 外掛程式是獨立分發的雲產品命令集合，支援按需自動安裝：

查看已安裝外掛程式：
```
aliyun plugin list
```

首次執行時自動安裝（CLI ≥ 3.3.0 預設行為）：

# 若 ecs 外掛程式未安裝，CLI 提示下載並緩衝
aliyun ecs describe-instances

手動安裝指定外掛程式：
```
aliyun plugin install --names ecs
```

更多外掛程式管理操作，請參見管理 CLI 外掛程式。

舊版CLI命令格式（OpenAPI 風格）

重要

阿里雲 CLI 自 3.3.0 版本起引入了外掛程式版命令（虛線風格，如 aliyun ecs describe-regions），替代了此前的舊版駝峰命令（如 aliyun ecs DescribeRegions）。為確保功能完整性與長期穩定性，強烈建議將現有指令碼及日常操作遷移至外掛程式版命令。

阿里雲雲產品 OpenAPI 分為 RPC 和 ROA 兩種風格類型，大部分產品使用 RPC 風格。不同風格介面的調用方式不同，使用舊版 OpenAPI 風格命令前需先判斷介面類型。一般情況下，每個產品內所有介面的調用風格是統一的，且每個介面僅支援特定的一種風格。更多關於 RPC 風格和 ROA 風格的資訊，請參見OpenAPI 風格。

RPC 風格命令結構

當頂級命令為雲產品 Code 且為 RPC 風格時，子命令通常為 OpenAPI 名稱。命令結構如下：

aliyun <ProductCode> <APIName> [Parameters]

樣本：查詢可用地區列表。

aliyun ecs DescribeRegions

ROA 風格命令結構

ROA 風格 OpenAPI 需要額外指定請求方式 Method 和訪問路徑 PathPattern。命令結構如下：

aliyun <ProductCode> <Method> <PathPattern> [RequestBody] [Parameters]

以下樣本為您展示如何調用Container Service Kubernetes 版DescribeClustersForRegion介面，查詢杭州地區下的ACK專有叢集。更多資訊，請參見查詢指定地區的叢集列表。

aliyun cs GET /regions/cn-hangzhou/clusters --cluster_type Kubernetes

ROA 風格 OpenAPI 的協助資訊會額外顯示請求方式 Method 和訪問路徑 PathPattern，便於確認調用格式。

判斷 OpenAPI 風格

可通過以下方式判斷介面使用的 OpenAPI 風格：

通過aliyun <command>後追加 --help 參數擷取產品可用 OpenAPI 列表。RPC 風格 OpenAPI 的協助資訊顯示介面簡述，ROA 風格則顯示訪問路徑 PathPattern。如：
```
# RPC風格
aliyun ecs --help
```
在aliyun <command> <sub-command>後追加 --help 查看參數詳情。ROA 風格 OpenAPI 的協助資訊會額外顯示介面的請求方式 Method 和訪問路徑 PathPattern。如：
```
# ROA風格
aliyun cs AttachInstances --help
```

說明

自 CLI 3.3.0 起，安裝雲產品外掛程式後，命令級 aliyun <command> --help 將預設展示外掛程式的協助資訊。如需查看原版協助，請設定環境變數 ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true。子命令級 aliyun <command> <sub-command> --help 行為保持不變。

使用命令協助資訊

阿里雲 CLI 提供三級 --help 下鑽能力。通過在外掛程式名（如 ecs）或子命令後追加 --help 參數，可以查看可用子命令列表和參數詳情。

展示全域命令和支援的外掛程式

aliyun --help

展示所有子命令

aliyun ecs --help

展示參數詳情

展示指定子命令的參數列表、是否必填、資料類型、預設值和樣本：

aliyun ecs describe-instances --help

協助資訊的關鍵標記

標記	說明
`[Required]`	必填參數
類型標註	參數資料類型，例如 String、Integer、Boolean、Array、JSON
預設值	例如 `--output json`（預設為 json）
樣本片段	通常位於 help 末尾，展示典型調用方式

常見問題

執行命令報錯 "Command not found"

該錯誤表示對應的雲產品外掛程式未安裝。CLI ≥ 3.3.0 支援首次執行時自動安裝。如因網路限制自動安裝失敗，可手動運行以下命令安裝外掛程式：

aliyun plugin install --names ecs

如何查看子命令支援的參數

運行 aliyun <command> <sub-command> --help 查看完整參數列表。