阿里云CLI采用统一的命令结构，支持通过`--help`查看命令帮助。-阿里云CLI(CLI)-阿里云帮助中心

阿里云 CLI 采用统一的命令结构。本文介绍命令各组成部分的含义，以及如何通过 --help 快速查看可用命令和参数。

前提条件

阿里云 CLI 的通用命令结构如下：

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

各部分说明：

command 为顶级命令，例如云产品代码 ecs 或管理命令 configure。
- 管理命令。例如：
  - configure（配置凭证和默认参数）。
  - plugin（管理插件）。
  - upgrade（升级 CLI 主程序）。
  完整的顶级命令列表可通过 aliyun --help-all 查看。
- 云产品代码（Product code）。例如 ecs、rds、cs、fc 等。
sub-command 为指定具体操作的子命令，不限定为 API 名称。
- 当顶级命令为管理命令时，可通过 aliyun <command> --help 查看具体参数或子命令。
- 云产品命令的操作示例为 DescribeInstances。
parameters 为命令参数，用于指定业务参数或控制 CLI 行为。更多参数格式信息，请参见理解命令行参数。
- 业务参数：以 -- 开头，例如 --InstanceId i-xxx。
- 全局参数：影响整个命令行为的通用参数，例如 --region cn-hangzhou、--profile prod等。

以下命令查询当前账号可访问的地域列表，无需额外参数即可执行：

aliyun ecs DescribeRegions

阿里云 CLI 提供三级 --help 下钻能力。通过在顶级命令（如 ecs）或子命令后追加 --help 参数，可以查看可用子命令列表和参数详情。Agent 环境可能裁剪帮助信息，如需获取完整命令和参数列表，请使用 --help-all。

aliyun --help-all

aliyun ecs --help-all

展示指定子命令的参数列表、是否必填、数据类型、默认值和示例：

aliyun ecs DescribeInstances --help

在命令后追加 --help-all，展示当前命令层级的完整帮助文档，包含全部子命令、参数和接入点等信息：

aliyun ecs --help-all

在命令后追加 --help-search <keyword>，在当前命令层级按关键词搜索匹配的命令和参数：

aliyun --help-search configure

追加 --cli-output json 以 JSON 格式输出帮助信息，便于脚本解析和 AI Agent 调用：

aliyun --help --cli-output json

说明

在受支持的 AI Agent 运行环境中，CLI 会自动检测环境并默认以 JSON 格式输出帮助信息。如需关闭该行为，设置环境变量 ALIBABA_CLOUD_CLI_AGENT_INTEGRATION=disabled。关于 AI 模式的更多信息，请参见AI 模式。

标记	说明
`[Required]`	必填参数
类型标注	参数数据类型，例如 String、Integer、Boolean、Array、JSON
默认值	例如 `--output json`（默认为 json）
示例片段	通常位于 help 末尾，展示典型调用方式

核对顶级命令和子命令的写法，通过命令帮助查询可用命令和参数；需要完整列表时使用 --help-all，并检查 CLI 版本。

运行 aliyun <command> <sub-command> --help 查看完整参数列表。