English | 简体中文
The Alibaba Cloud CLI is an open source tool, you can get the latest version from GitHub. You can also try it out in the Cloud Shell before installing the CLI.
The Alibaba Cloud CLI is a tool to manage and use Alibaba Cloud resources through a command line interface. It is written in Go and built on the top of Alibaba Cloud OpenAPI.
Note: Alibaba Cloud CLI access the Alibaba Cloud services through OpenAPI. Before using Alibaba Cloud CLI, make sure that you have activated the service to use and known how to use OpenAPI.
The release notes for the CLI can be found in the CHANGELOG
-
Download installer (Recommended)
Download the installer, then extract the installer. You can move the extracted
aliyun
executable file to the/usr/local/bin
directory or add it to the$PATH
.Download link: (3.0.37)
-
Use brew If you have installed
brew
in your computer, you can use it to install Alibaba Cloud CLI as following:
brew install aliyun-cli
If you need detailed installation steps or compile the installation steps, please visit Installation Guide.
For detailed configuration instructions, please visit the official website Configuration Alibaba Cloud CLI.
Before using Alibaba Cloud CLI to invoke the services, you need to configure the credential information, region, language, etc.
You can run the aliyun configure
command for quick configuration.
$ aliyun configure
Configuring profile 'default' ...
Aliyun Access Key ID [None]: <Your AccessKey ID>
Aliyun Access Key Secret [None]: <Your AccessKey Secret>
Default Region Id [None]: cn-hangzhou
Default output format [json]: json
Default Languate [zh]: zh
You can specify the authentication method to use by using the configure
command with the --mode <authenticationMethod>
option.
The following are supported authentication methods:
Authentication methods | Description |
---|---|
AK | Use AccessKey ID and Secret to access Alibaba Cloud services |
StsToken | Use STS token to access Alibaba Cloud services |
RamRoleArn | Use the AssumeRole to access Alibaba Cloud services |
EcsRamRole | Use the EcsRamRole to access ECS resources |
- Use
aliyun auto-completion
command to enable auto completion in zsh/bash - Use
aliyun auto-completion --uninstall
command to disable auto completion.
Here is the basic usage guidelines. If you need a detailed manual, please visit Use Alibaba Cloud CLI
The Alibaba Cloud OpenAPI has two styles, RPC style and RESTful style. Most of the Alibaba Cloud products use the RPC style. The way of calling an API varies depending on the API style.
You can distinguish the API style from the following characteristics:
- The API requiring the
Action
parameter is the RPC style, while the API requiring thePathPattern
parameter is the RESTful style. - In general, the API style for a product is consistent.
- Each API only supports one style. If an incorrect calling method is used, another API may be called or an error
ApiNotFound
is returned.
The following statement shows how to call RPC APIs in the Alibaba Cloud CLI:
aliyun <product> <operation> --parameter1 value1 --parameter2 value2 ...
Examples:
aliyun rds DescribeDBInstances --PageSize 50
aliyun ecs DescribeRegions
aliyun rds DescribeDBInstanceAttribute --DBInstanceId xxxxxx
APIs of some products such as Container Service are RESTful style. The way to call RESTful APIs is different from RPC APIs.
The following examples show how to call RESTful APIs in the Alibaba Cloud CLI:
-
GET request:
aliyun cs GET /clusters
-
POST request:
aliyun cs POST /clusters --body "$(cat input.json)"
-
DELETE request:
aliyun cs DELETE /clusters/ce2cdc26227e09c864d0ca0b2d5671a07
Alibaba Cloud CLI integrates API descriptions for some products, you can get help by using the following commands:
-
aliyun help
: get product list -
aliyun help <product>
: get the API information of a specific productFor example, get help of ECS APIs:
$ aliyun help ecs
-
$ aliyun help <product> <apiName>
: get the detailed API information of a specific APUFor example, get the help information of the CreateInstance API:
aliyun help ecs CreateInstance
Alibaba Cloud CLI integrates the product metadata of some products. It will validate API parameters when calling the API. If an API or a parameter that is not included in the metadata is used, an error unknown api
or unknown parameter
will be returned. You can use the --force
option to skip the validation and call the API by force as shown in the following example:
aliyun newproduct --version 2018-01-01 --endpoint newproduct.aliyuncs.com --param1 ... --force
The following two options are required when using the --force
option:
--version
: the API version. You can find the API version in the API documentation. For example, the ECS API version is2014-05-26
.--endpoint
: the product endpoint. Get the product endpoint in the corresponding API documentation.
When you input some argument like "-PortRange -1/-1", will cause parse error.In this case, you could assign value like this: --PortRange=-1/-1.
We use GitHub issues to track bugs and feature requests for user feedback. Please visit the following site for assistance:
-
Please visit Alibaba Cloud CLI for the manual.
-
Ask a question on Stack Overflow and tag it with aliyun-cli
-
If you find a bug or want to add a feature, please submit issue.