关于 Alibaba Cloud CLI
Alibaba Cloud CLI 是阿里云官方命令行工具,提供对阿里云 OpenAPI 的完整访问。支持多个配置文件、SSO 登录和请求诊断功能,适合在脚本和自动化中调用阿里云服务。
主要功能
- 01通过 OpenAPI 访问阿里云所有服务(计算、存储、网络等)
- 02使用配置文件管理多个账户和凭证
- 03诊断请求失败并查看 API 响应详情
- 04结构化输出支持 JSON 和表格格式
适用场景
- 01编码 Agent 自动部署和管理阿里云基础设施
- 02脚本中批量操作 ECS 实例、OSS 存储桶等资源
- 03在 CI/CD 工作流中集成阿里云服务调用
安装
选择你的系统或包管理器,复制命令到终端运行。
安装完成后运行aliyun --version确认安装成功。
命令示例
常用命令按使用顺序排列。
详细介绍
Alibaba Cloud CLI
一款通过 OpenAPI 管理 Alibaba Cloud 资源的跨平台命令行工具。
Alibaba Cloud CLI(aliyun)使用 Go 编写,可在 macOS、Linux 和 Windows 上运行。它支持交互式和非交互式凭证配置、OpenAPI 调用、本地 API 帮助、结构化输出、等待器、安全控制以及可扩展的插件系统。
Alibaba Cloud CLI 通过 OpenAPI 调用云服务。请先开通目标服务,并确保你的身份拥有所需权限。如果可以使用临时凭证或基于身份的凭证模式,请避免使用长期有效的 AccessKey。
安装
选择以下一种方式:
# Homebrew
brew install aliyun-cli
# macOS or Linux installer script
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)"
官方安装包:
验证安装:
aliyun version
升级现有的独立安装:
aliyun upgrade
如果通过软件包管理器安装了 CLI,请优先使用该软件包管理器的升级命令。
有关 PATH 配置、源码构建和升级,请参阅安装指南。
如需在本地不安装 CLI 的情况下试用,请打开 Alibaba Cloud Shell:
快速开始
1. 配置配置文件
在交互式本地环境中,OAuth 可避免存储长期有效的 AccessKey:
aliyun configure --mode OAuth --profile default
对于没有浏览器的远程机器,请使用:
aliyun configure --mode OAuth --profile default --no-browser
在带有浏览器的设备上打开打印出的授权链接。登录后,
从地址栏复制完整的回调 URL,并粘贴到 CLI 中,
即使浏览器显示连接错误也要这样做。请同时包含 code 和 state。
此模式不会启动本地回调服务,也不需要端口转发。
按 Ctrl+C 取消。
在适用的情况下,你也可以使用 AK、StsToken、RamRoleArn、EcsRamRole、OIDC、External、CredentialsURI、ChainableRamRoleArn、CloudSSO、BearerToken 或 Anonymous 模式。
# Inspect and select profiles
aliyun configure list
aliyun configure switch --profile default
在生产环境或 CI 中使用配置文件前,请参阅配置和凭证。
2. 调用 API
在元数据可用时,支持传统的 PascalCase 形式和基于元数据的 kebab-case 形式:
aliyun ecs DescribeRegions
aliyun ecs describe-regions
安全策略会以不区分大小写的方式匹配命令名称,但不会展开 API 别名。请为自动化使用的每个命令名称配置规则。请参阅命令匹配规则。
3. 探索帮助信息
aliyun --help
aliyun ecs DescribeInstances --help
aliyun ecs describe-instances --help
常见功能
筛选和格式化输出
aliyun ecs DescribeInstances \
--output cols=InstanceId,Status rows=Instances.Instance[]
aliyun ecs describe-instances \
--cli-query 'Instances.Instance[].{Id:InstanceId,Status:Status}'
等待资源状态
aliyun ecs DescribeInstances \
--InstanceIds '["i-example"]' \
--waiter expr='Instances.Instance[0].Status' to=Running
使用产品插件
aliyun plugin search <command-name>
aliyun plugin install --name <plugin-name>
aliyun plugin list
aliyun plugin update --name <plugin-name>
故障排查
OpenAPI 故障排查 可通过 RequestId 或错误消息帮助诊断 OpenAPI 请求失败。
文档
| 主题 | English | 简体中文 |
|---|---|---|
| 文档索引 | English | 中文 |
| 安装和升级 | 指南 | 指南 |
| 配置和凭证 | 指南 | 指南 |
| 命令、输出和自动化 | 指南 | 指南 |
| MCP、OpenTelemetry 和机器接口 | 指南 | 指南 |
| 内置 OSS 自动化 | 指南 | 指南 |
| 插件管理 | 指南 | 指南 |
其他资源:
支持
- 搜索现有问题,或提交 GitHub issue。
- 如果怀疑存在安全漏洞,请按照 SECURITY.md 中的说明操作,而不要公开提交 issue。
- 发布说明和二进制文件可在发布页面获取。
许可证
Alibaba Cloud CLI 根据 Apache License 2.0 授权。