Alibaba Cloud CLI

https://help.aliyun.com/zh/cli
Admin
Alibaba Cloud CLI is a management tool based on Alibaba Cloud's open API, allowing users to manage...
Tokens:98,005
Snippets:742
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Interactive installation prompt output example

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Shows the output when auto-install is not enabled in an interactive terminal. The CLI prompts for confirmation before installing the plugin.

```bash
# 未安装 ecs 插件的情况下执行
aliyun ecs describe-regions --accept-language zh-CN
# 交互式安装过程输出
Plugin 'aliyun-cli-ecs' is required for command 'ecs describe-regions' but not installed.
Tip: Run 'aliyun configure set --auto-plugin-install true' to skip this prompt.
Do you want to install it? [Y/n]: y
Installing plugin 'aliyun-cli-ecs' (including pre-release versions)...
Downloading aliyun-cli-ecs 0.1.0...
Plugin aliyun-cli-ecs 0.1.0 installed successfully!
......
```

--------------------------------

### Allow auto-install of pre-release plugins via command

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Allows automatic installation of pre-release versions of plugins. Verify with 'aliyun configure get'.

```bash
aliyun configure set --auto-plugin-install-enable-pre true
```

--------------------------------

### Help output example

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Example output from `aliyun ecs describe-regions --help` showing parameter types, descriptions, and defaults.

```bash
......
  --accept-language         string, 根据汉语、英语和日语筛选返回结果。更多详情，请参见[RFC
                            7231](https://tools.ietf.org/html/rfc7231)。取值范围：
                            - zh-CN：简体中文。
                            - zh-TW：繁体中文。
                            - en-US：英文。
                            - ja：日文。
                            - fr：法语。
                            - de：德语。
                            - ko：韩语。
                            默认值：zh-CN
  --instance-charge-type    string, 实例的计费方式，更多信息，请参见https://help.aliyun.
                            com/document_detail/25398.html。取值范围：
                            - PrePaid：包年包月。此时，请确认自己的账号支持余额支付或者信用支付，
                            否则将报错InvalidPayMethod。
                            - PostPaid：按量付费。
                            - SpotWithPriceLimit：设置上限价格。
                            - SpotAsPriceGo：系统自动出价，最高按量付费价格。
                            默认值：PostPaid
......
```

--------------------------------

### Auto-install output example

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Shows the output when auto-install is enabled and the ecs plugin is missing. The CLI automatically installs the plugin and continues execution.

```bash
# 未安装 ecs 插件的情况下执行
aliyun ecs describe-regions --accept-language zh-CN
# 自动安装过程输出
Plugin 'aliyun-cli-ecs' is required for command 'ecs describe-regions' but not installed.
Auto-installing plugin 'aliyun-cli-ecs' (including pre-release versions)...
Downloading aliyun-cli-ecs 0.1.0...
Plugin aliyun-cli-ecs 0.1.0 installed successfully!
......
```

--------------------------------

### Install cloud product plugins

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Use these commands to install one or multiple cloud product plugins. The first installs a single plugin, the second installs multiple plugins at once.

```bash
# 安装单个插件
aliyun plugin install --name ecs

# 批量安装多个插件
aliyun plugin install --names ecs oss vpc
```

--------------------------------

### Plugin list output example

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Example output from `aliyun plugin list` showing plugin names, versions, and descriptions, including multi-version API support.

```bash
Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               Aliyun CLI plugin for Elastic Compute Service operations.
aliyun-cli-ess      0.1.0               Aliyun CLI plugin for Auto Scaling operations with multi-version API support.
aliyun-cli-fc       0.1.0               Aliyun CLI plugin for Function Compute 3.0 operations.
```

--------------------------------

### aliyun configure get --profile OAuthProfile profile mode language - Example 2

Source: https://help.aliyun.com/zh/cli/configure-credentials

Shows only the specified settings (profile, mode, language) for the OAuthProfile profile. Output is in key=value format.

```bash
aliyun configure get --profile OAuthProfile profile mode language
```

--------------------------------

### aliyun configure get --profile OAuthProfile - Example 1

Source: https://help.aliyun.com/zh/cli/configure-credentials

Shows the full configuration details for the profile named OAuthProfile, including access keys, STS token, region, language, and OAuth tokens.

```bash
aliyun configure get --profile OAuthProfile
```

--------------------------------

### Install a CLI plugin

Source: https://help.aliyun.com/zh/cli/cloud-products-supporting-cli

Install a specific plugin using 'aliyun plugin install --names <plugin-name>'. After installation, invoke the plugin with 'aliyun <plugin-name> <sub-command>'.

```bash
aliyun plugin install --names <plugin-name>
```

--------------------------------

### Enable auto plugin installation via command

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Enables automatic plugin installation when executing cloud product commands. Recommended for non-interactive environments like CI/CD or scripts. Verify with 'aliyun configure get'.

```bash
aliyun configure set --auto-plugin-install true
```

--------------------------------

### CredentialsURI: Start interactive configuration

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

Run this command to start configuring a CredentialsURI profile. Replace <ProfileName> with a custom name like 'URIProfile'.

```bash
aliyun configure --mode CredentialsURI --profile <ProfileName>
```

--------------------------------

### aliyun configure switch --profile prod - Example

Source: https://help.aliyun.com/zh/cli/configure-credentials

Switches the active profile to 'prod'. Verify with 'aliyun configure list' to confirm the asterisk marker.

```bash
aliyun configure switch --profile prod
```

--------------------------------

### Start CloudSSO configuration with aliyun configure

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

Run this command to start configuring a CloudSSO profile. Replace <ProfileName> with a custom name like SSOProfile.

```bash
aliyun configure --mode CloudSSO --profile <ProfileName>
```

--------------------------------

### Allow auto-install of pre-release plugins via environment variable

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Allows automatic installation of pre-release versions by setting the ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL_ENABLE_PRE environment variable in ~/.bashrc (Linux example).

```bash
# 添加环境变量并生效
echo 'export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL_ENABLE_PRE=true' >> ~/.bashrc
source ~/.bashrc
```

--------------------------------

### Help output for aliyun ecs describe-instances --help

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

This is the help output for the plugin command, showing parameters, global flags, and examples.

```bash
Description: Queries a list of instances and their details based on specified conditions

API Version: 2014-05-26

Usage:
  aliyun ecs describe-instances [parameters]

Parameters:
  --biz-region-id                string (required), The ID of the region where the
                                 instance resides. You can call https://help.aliyun.
                                 com/document_detail/25609.html to query the latest
                                 list of Alibaba Cloud regions
  --additional-attributes        list, The list of other instance attributes
                                 format: --additional-attributes value1 value2 value3
  --device-available             bool, > This parameter is in invitational preview
                                 and is not available for use
......

Global Flags:
  --cli-ai-mode             bool, For this run, enable AI-mode
  --cli-dry-run             bool, Enable dry-run mode: print request details
                            without sending the actual API call
  --cli-query               string, Use `--cli-query <jmespath>` to filter
                            output with JMESPath expression
  --endpoint                string, Override service endpoint (e.g., --endpoint
                            https://ecs.cn-hangzhou.aliyuncs.com)
......

Examples:
  aliyun ecs describe-instances --biz-region-id example-value
  aliyun ecs describe-instances --biz-region-id example-value --vpc-id example-value
```

--------------------------------

### Install plugin with pre-release version using --enable-pre

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Use this command when plugin installation fails with 'no stable version available'. The `--enable-pre` parameter allows installing pre-release versions of the plugin.

```bash
aliyun plugin install --name <插件名> --enable-pre
```

--------------------------------

### Output of aliyun plugin list-remote

Source: https://help.aliyun.com/zh/cli/cloud-products-supporting-cli

Example console output from 'aliyun plugin list-remote' showing available plugins, their versions, and installation status. The output is truncated with '......'.

```bash
Total plugins available: 320

Name                      Latest Version  Preview  Status         Local Version  Description
----                      --------------  -------  ------         -------------  -----------
aliyun-cli-bssopenapi     0.2.0           No       Installed      0.2.0          Aliyun CLI plugin for Alibaba Cloud Billing operations with multi-version API support.
aliyun-cli-ecs            0.2.0           No       Installed      0.1.0          Aliyun CLI plugin for Elastic Compute Service operations.
aliyun-cli-ess            0.2.0           No       Installed      0.1.0          Aliyun CLI plugin for Auto Scaling operations with multi-version API support.
aliyun-cli-fc             0.2.0           No       Installed      0.1.0          Aliyun CLI plugin for Function Compute 3.0 operations.
......
```

--------------------------------

### Run Install-CLI-Windows.ps1 with custom version and install directory

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

Runs the installation script with -Version 3.3.15 and -InstallDir "C:\ExampleDir\AliyunCLI" to install a specific version to a custom directory. Replace the script path with the actual location.

```powershell
powershell.exe -ExecutionPolicy Bypass -File C:\Example\Install-CLI-Windows.ps1 -Version 3.3.15 -InstallDir "C:\ExampleDir\AliyunCLI"
```

--------------------------------

### Enable auto plugin installation via environment variable

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Enables automatic plugin installation by setting the ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL environment variable in ~/.bashrc (Linux example).

```bash
# 添加环境变量并生效
echo 'export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL=true' >> ~/.bashrc
source ~/.bashrc
```

--------------------------------

### List and search available CLI plugins

Source: https://help.aliyun.com/zh/cli/cloud-products-supporting-cli

Use 'aliyun plugin list-remote' to list all available plugins and 'aliyun plugin search <关键词>' to search by keyword with prefix matching. The output shows a table of available plugins with their versions and installation status.

```bash
# 列出所有可用插件
aliyun plugin list-remote
# 按关键词搜索，前缀匹配
aliyun plugin search <关键词> 
```

--------------------------------

### Old version pipeline command with jq

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Example of the old CLI version for getting all running instance IDs using 'DescribeInstances' and piping to jq. The output structure may differ in the plugin version.

```bash
aliyun ecs DescribeInstances --RegionId cn-hangzhou \
  | jq -r '.Instances.Instance[] | select(.Status=="Running") | .InstanceId'
```

--------------------------------

### Install ECS plugin with aliyun plugin install --names ecs

Source: https://help.aliyun.com/zh/cli/quickly-start-using-alibaba-cloud-cli

Installs the ECS plugin for Alibaba Cloud CLI. Successful installation outputs 'Plugin aliyun-cli-ecs x.x.x installed successfully!'.

```bash
aliyun plugin install --names ecs
```

--------------------------------

### Output of aliyun configure get --profile OAuthProfile profile mode language

Source: https://help.aliyun.com/zh/cli/configure-credentials

Example output showing the requested settings in plaintext key=value format.

```plaintext
profile=OAuthProfile
mode=OAuth
language=en
```

--------------------------------

### Region list output example

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Example JSON output from the region query command.

```bash
{
  "Regions": {
     "Region": [
	{
	   "LocalName": "华北1（青岛）",
	   "RegionEndpoint": "ecs.cn-qingdao.aliyuncs.com",
	   "RegionId": "cn-qingdao"
			},
	{
	   "LocalName": "华北2（北京）",
	   "RegionEndpoint": "ecs.cn-beijing.aliyuncs.com",
	   "RegionId": "cn-beijing"
	},
......
```

--------------------------------

### Start interactive ChainableRamRoleArn configuration

Source: https://help.aliyun.com/zh/cli/ram-role-credentials

Run this command to begin interactive configuration. Replace <ProfileName> with your desired profile name, e.g., ChainProfile.

```bash
aliyun configure --mode ChainableRamRoleArn --profile <ProfileName>
```

--------------------------------

### Plugin version command with complex JSON parameters

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Example of the plugin version for the same operation, using kebab-case parameter names and the 'add-backend-servers' command.

```bash
aliyun slb add-backend-servers \
  --load-balancer-id lb-xxx \
  --backend-servers '[{"ServerId":"i-aaa","Weight":100},{"ServerId":"i-bbb","Weight":80}]'
```

--------------------------------

### Run Install-CLI-Windows.ps1 with default settings

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

Runs the installation script with default parameters, installing the latest version to the default directory C:\Users\<USERNAME>\AppData\Local\AliyunCLI. Uses -ExecutionPolicy Bypass to avoid execution policy restrictions.

```powershell
powershell.exe -ExecutionPolicy Bypass -File C:\Example\Install-CLI-Windows.ps1
```

--------------------------------

### Install latest Alibaba Cloud CLI via Homebrew

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

Installs the latest version of the Alibaba Cloud CLI using Homebrew.

```bash
brew install aliyun-cli
```

--------------------------------

### Plugin version pipeline command with jq

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Example of the plugin version for the same operation, using 'describe-instances'. The output structure may differ, so use '--help' to confirm the output structure and adjust the jq expression accordingly.

```bash
# 插件版：先用 --help 确认输出结构，再调整 jq 表达式
aliyun ecs describe-instances --region cn-hangzhou \
  | jq -r '.Instances.Instance[] | select(.Status=="Running") | .InstanceId'
```

--------------------------------

### aliyun configure get - View profile details

Source: https://help.aliyun.com/zh/cli/configure-credentials

Displays detailed configuration for a specified profile. You can specify one or more setting names; if omitted, all settings are shown. If a setting does not exist, no output is returned.

```bash
aliyun configure get [--profile <ProfileName>] [<SETTING_NAME>...]
```

--------------------------------

### Install-CLI-Windows.ps1 - PowerShell installation script for Alibaba Cloud CLI

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

Full PowerShell script that downloads and installs Alibaba Cloud CLI on Windows AMD64. Supports -Version and -InstallDir parameters, modifies only User-level and Process-level PATH, and defaults to latest version and $env:LOCALAPPDATA\AliyunCLI. Exits with error if the system is not 64-bit AMD64.

```powershell
# Install-CLI-Windows.ps1
# Purpose: Install Alibaba Cloud CLI on Windows AMD64 systems.
# Supports custom version and install directory. Only modifies User-level and Process-level PATH.

[CmdletBinding()]
param (
    [string]$Version = "latest",
    [string]$InstallDir = "$env:LOCALAPPDATA",
    [switch]$Help
)

function Show-Usage {
    Write-Output @"

      Alibaba Cloud Command Line Interface Installer

    -Help                 Display this help and exit

    -Version VERSION      Custom CLI version. Default is 'latest'

    -InstallDir PATH      Custom installation directory. Default is:
                          $InstallDir\AliyunCLI

"@
}

function Write-ErrorExit {
    param([string]$Message)
    Write-Error $Message
    exit 1
}

if ($PSBoundParameters['Help']) {
    Show-Usage
    exit 0
}

Write-Output @"
..............888888888888888888888 ........=8888888888888888888D=..............
...........88888888888888888888888 ..........D8888888888888888888888I...........
.........,8888888888888ZI: ...........................=Z88D8888888888D..........
.........+88888888 ..........................................88888888D..........
.........+88888888 .......Welcome to use Alibaba Cloud.......O8888888D..........
.........+88888888 ............. ************* ..............O8888888D..........
.........+88888888 .... Command Line Interface(Reloaded) ....O8888888D..........
.........+88888888...........................................88888888D..........
..........D888888888888DO+. ..........................?ND888888888888D..........
...........O8888888888888888888888...........D8888888888888888888888=...........
............ .:D8888888888888888888.........78888888888888888888O ..............
"@

$OSArchitecture = (Get-WmiObject -Class Win32_OperatingSystem).OSArchitecture

$ProcessorArchitecture = [int](Get-WmiObject -Class Win32_Processor).Architecture

if (-not ($OSArchitecture -match "64") -or $ProcessorArchitecture -ne 9) {
    Write-ErrorExit "Alibaba Cloud CLI only supports Windows AMD64 systems. Please run on a compatible system."
}

$DownloadUrl = "https://aliyuncli.alicdn.com/aliyun-cli-windows-$Version-amd64.zip"

$tempPath = $env:TEMP
$randomName = -join ((65..90) + (97..122) + (48..57) | Get-Random -Count 8)
$DownloadDir = Join-Path -Path $tempPath -ChildPath $randomName
New-Item -ItemType Directory -Path $DownloadDir | Out-Null

try {
    $InstallDir = Join-Path $InstallDir "AliyunCLI"
    if (-not (Test-Path $InstallDir)) {
        New-Item -ItemType Directory -Path $InstallDir -Force | Out-Null
    }

    $ZipPath = Join-Path $DownloadDir "aliyun-cli.zip"
    Start-BitsTransfer -Source $DownloadUrl -Destination $ZipPath

    Expand-Archive -Path $ZipPath -DestinationPath $DownloadDir -Force

    Move-Item -Path "$DownloadDir\aliyun.exe" -Destination "$InstallDir\" -Force

    $Key = 'HKCU:\Environment'
    $CurrentPath = (Get-ItemProperty -Path $Key -Name PATH).PATH

    if ([string]::IsNullOrEmpty($CurrentPath)) {
        $NewPath = $InstallDir
    } else {
        if ($CurrentPath -notlike "*$InstallDir*") {
            $NewPath = "$CurrentPath;$InstallDir"
        } else {
            $NewPath = $CurrentPath
        }
    }

    if ($NewPath -ne $CurrentPath) {
        Set-ItemProperty -Path $Key -Name PATH -Value $NewPath
        $env:PATH += ";$InstallDir"
    }
} catch {
    Write-ErrorExit "Failed to install Alibaba Cloud CLI: $_"
} finally {
    Remove-Item -Path $DownloadDir -Recurse -Force | Out-Null
}

```

--------------------------------

### BearerToken: Start interactive configuration

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

Run this command to start interactive configuration for a BearerToken profile. Replace <ProfileName> with a custom name like 'BearerProfile'.

```bash
aliyun configure --mode BearerToken --profile <ProfileName>
```

--------------------------------

### Interactive configuration

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

Start interactive configuration for External credentials, prompting for process command, region, and language.

```bash
aliyun configure --mode External --profile <ProfileName>
```

--------------------------------

### Install historical version 3.3.5 via Bash script

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

Installs a specific historical version (3.3.5) of the Alibaba Cloud CLI using the official installation script with the -V flag.

```bash
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)" -- -V 3.3.5
```

--------------------------------

### Example JSON response from describe-regions

Source: https://help.aliyun.com/zh/cli/quickly-start-using-alibaba-cloud-cli

Example output from the describe-regions command, showing a list of regions with their IDs, endpoints, and local names, along with a RequestId.

```json
{
  "Regions": {
    "Region": [
      {
        "RegionId": "cn-hangzhou",
        "RegionEndpoint": "ecs.cn-hangzhou.aliyuncs.com",
        "LocalName": "华东1（杭州）"
      },
      {
        "RegionId": "cn-shanghai",
        "RegionEndpoint": "ecs.cn-shanghai.aliyuncs.com",
        "LocalName": "华东2（上海）"
      },
      {
        "RegionId": "cn-beijing",
        "RegionEndpoint": "ecs.cn-beijing.aliyuncs.com",
        "LocalName": "华北2（北京）"
      }
    ]
  },
  "RequestId": "5BEAEC76-E9B4-47B2-8D24-A3C31D5D2EEF"
}
```

--------------------------------

### aliyun configure delete --profile dev - Example

Source: https://help.aliyun.com/zh/cli/configure-credentials

Deletes the profile named 'dev'. After deletion, verify with 'aliyun configure list'.

```bash
aliyun configure delete --profile dev
```

--------------------------------

### Output of aliyun configure list

Source: https://help.aliyun.com/zh/cli/configure-credentials

Example output showing profiles, credential types, validity, region, and language. The active profile is marked with an asterisk (*).

```plaintext
Profile      | Credential               | Valid   | Region           | Language
---------    | ------------------       | ------- | ---------------- | --------
default      | AK:***UyLX               | Valid   | cn-shanghai      | en
OAuthProfile | OAuth:fiA5bnZkyw@CN      | Valid   | cn-hangzhou      | en
EcsProfile * | EcsRamRole:ecs-role-name | Valid   | cn-beijing       | zh
```

--------------------------------

### Interactive configuration prompts for ChainableRamRoleArn

Source: https://help.aliyun.com/zh/cli/ram-role-credentials

Shows the prompts and example inputs during interactive configuration. The source profile must already exist; the RAM role ARN is an example. Sts Region and External ID can be skipped by pressing Enter.

```plaintext
Configuring profile 'ChainableProfile' in 'ChainableRamRoleArn' authenticate mode...
Source Profile []: RamRoleArnProfile
Sts Region []: cn-hangzhou
Ram Role Arn []: acs:ram::012345678910****:role/Alice
Role Session Name []: alice
External ID []: abcd1234
Expired Seconds [900]: 900
Default Region Id []: cn-hangzhou
Default Output Format [json]: json (Only support json)
Default Language [zh|en] en: en
Saving profile[ChainableProfile] ...Done.
```

--------------------------------

### Pre-install plugins in CI/CD pipeline

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

In non-interactive environments, the CLI does not prompt for plugin installation. Pre-install plugins in the pipeline script using the 'aliyun plugin install' command with the '--names' flag.

```bash
aliyun plugin install --names ecs oss vpc
```

--------------------------------

### Show plugin details

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Use `aliyun plugin show --name ecs` to display detailed information about a specific plugin, including version, installation path, and supported API versions.

```bash
# 查看指定插件的详细信息
aliyun plugin show --name ecs
```

--------------------------------

### Configure AccessKey with aliyun configure --mode AK

Source: https://help.aliyun.com/zh/cli/quickly-start-using-alibaba-cloud-cli

Starts the interactive AccessKey configuration for the default profile. Follow the prompts to enter AccessKey ID, Secret, default region ID, and language. The --profile default flag saves the credentials under the 'default' profile.

```bash
aliyun configure --mode AK --profile default
```

--------------------------------

### View help for built-in command: aliyun configure --help

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

Run this command to see help for a built-in command (e.g., configure). The output shows subcommands and options.

```bash
aliyun configure --help
```

--------------------------------

### View plugin help

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Use `aliyun ecs --help` to list all supported commands for the ecs plugin.

```bash
aliyun ecs --help
```

--------------------------------

### View help for legacy CLI command: aliyun ecs DescribeInstances --help

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

Run this command to see help for a legacy CLI command (OpenAPI style). The output shows parameters in PascalCase style from API metadata.

```bash
aliyun ecs DescribeInstances --help
```

--------------------------------

### Help output for aliyun configure --help

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

This is the help output for the built-in configure command, listing subcommands and usage.

```bash
configure credential and settings

Usage:
  aliyun configure --mode {AK|RamRoleArn|EcsRamRole|OIDC|External|CredentialsURI|ChainableRamRoleArn|CloudSSO|OAuth} --profile <profileName> [--config-path <configPath>]

Commands:
  get             print configuration values
  set             set config in non interactive mode
  list            list all config profile
  delete          delete the specified profile
  switch          switch default profile
  safety-policy   manage safety policy and human-in-the-loop rules
  ai-mode         manage global AI mode and User-Agent for API calls
  plugin-settings manage global plugin system settings
```

--------------------------------

### Temporarily view legacy help

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Set the ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP environment variable to true to temporarily view the old version help instead of the plugin help.

```bash
export ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true
```

--------------------------------

### Help output for aliyun ecs DescribeInstances --help

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

This is the help output for the legacy CLI command, showing parameters in PascalCase style.

```bash
Product: Ecs (Elastic Compute Service)

Parameters:
  --RegionId String  Required

  The region ID of the instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.

  --AdditionalAttributes.n RepeatList Optional

  The additional instance attributes.
......
```

--------------------------------

### Enable automatic plugin installation via environment variable

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Set this environment variable to enable automatic installation of plugins when executing plugin-based commands if the corresponding plugin is not installed. Note that export only affects the current shell session; to persist, add it to the shell configuration file.

```bash
export ALIBABA_CLOUD_CLI_PLUGIN_AUTO_INSTALL=true
```

--------------------------------

### 创建 systemd 服务文件 aliyun-mcp-proxy

Source: https://help.aliyun.com/zh/cli/use-aliyun-mcp-proxy-agent-openapi-mcp-server

创建 systemd 服务文件，需替换 your-user 和 /usr/local/bin/aliyun 为实际值。ExecStart 必须填写 aliyun 命令的绝对路径，systemd 不通过 shell 解析该字段。

```bash
sudo tee /etc/systemd/system/aliyun-mcp-proxy.service << 'EOF'
[Unit]
Description=Aliyun CLI MCP Proxy
After=network.target
[Service]
Type=simple
User=your-user
ExecStart=/usr/local/bin/aliyun utils mcp-proxy --host 127.0.0.1 --port 8088 --no-browser
Restart=always
RestartSec=10
Environment=HOME=/home/your-user
[Install]
WantedBy=multi-user.target
EOF
```

--------------------------------

### Windows: 通过 PowerShell 卸载 aliyun.exe

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

适用于 PowerShell 脚本安装方式，删除默认安装目录下的 aliyun.exe。如使用自定义路径，请将 $InstallDir 替换为实际路径。

```powershell
$InstallDir = Join-Path $env:LOCALAPPDATA "AliyunCLI"
Remove-Item -Path "$InstallDir\aliyun.exe" -Force
```

--------------------------------

### 使用 aliyun configure set 修改配置

Source: https://help.aliyun.com/zh/cli/configure-credentials

当交互式配置输错时，使用此命令修改对应字段，无需重新完整配置。将 `<ProfileName>` 替换为配置名称，`<ParameterName>` 替换为要修改的参数名，`<CorrectValue>` 替换为正确的值。

```bash
aliyun configure set --profile <ProfileName> --<ParameterName> <CorrectValue>
```

--------------------------------

### Update all installed plugins

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Updates all installed plugins. If plugins are already up-to-date, the CLI will prompt that no update is needed. Add '--enable-pre' to update to pre-release versions.

```bash
aliyun plugin update
```

--------------------------------

### Parameter Value Starting with Hyphen (Equals Sign)

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

Connecting the parameter name and value with an equals sign resolves the issue when the value starts with '-'. This is the recommended approach.

```bash
aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange=-1/-1 --method POST --force
```

--------------------------------

### 判断 OpenAPI 风格：RPC 风格帮助

Source: https://help.aliyun.com/zh/cli/understanding-command-structure

通过 aliyun <command> --help 获取产品可用 OpenAPI 列表，RPC 风格帮助信息显示接口简述。

```bash
# RPC风格
aliyun ecs --help
```

--------------------------------

### 跳过确认更新阿里云 CLI：aliyun upgrade --yes

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

v3.3.5 及以上版本支持此命令，一键更新到最新版本，无需确认。该命令适用于非 Homebrew 安装方式的 CLI。

```bash
aliyun upgrade --yes
```

--------------------------------

### Set Homebrew installation source to USTC mirror

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

Optional step for users in mainland China who may have network issues installing Homebrew. Sets environment variables to use the USTC mirror and then runs brew update.

```bash
export HOMEBREW_INSTALL_FROM_API=1
export HOMEBREW_BREW_GIT_REMOTE="https://mirrors.ustc.edu.cn/brew.git"
export HOMEBREW_CORE_GIT_REMOTE="https://mirrors.ustc.edu.cn/homebrew-core.git"
export HOMEBREW_BOTTLE_DOMAIN="https://mirrors.ustc.edu.cn/homebrew-bottles"
export HOMEBREW_API_DOMAIN="https://mirrors.ustc.edu.cn/homebrew-bottles/api"
brew update
```

--------------------------------

### Parameter Value Starting with Hyphen (Quoted)

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

When a parameter value starts with '-', the CLI may misinterpret it as another parameter name. Quoting the value with double quotes can help, but the recommended fix is to use an equals sign.

```bash
aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange "-1/-1" --method POST --force
```

--------------------------------

### 验证阿里云 CLI 运行：aliyun configure list

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

进一步确认 CLI 可正常工作。如果显示凭证配置列表（即使为空），则确认 CLI 运行正常。

```bash
aliyun configure list
```

--------------------------------

### MCP 代理启动成功输出示例

Source: https://help.aliyun.com/zh/cli/use-aliyun-mcp-proxy-agent-openapi-mcp-server

当终端显示 MCP Proxy Server Started 信息时，表示代理启动成功。

```bash
MCP Profile 'default-mcp' configured for oauth app 'aliyun-cli-mcp-proxy' successfully!

MCP Proxy Server Started
Listen: 127.0.0.1:8088
Region: CN
```

--------------------------------

### 移动 aliyun 可执行文件到 /usr/local/bin

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

将可执行文件移动至 /usr/local/bin 目录，使 aliyun 命令可在任意路径下运行。

```bash
sudo mv ./aliyun /usr/local/bin/
```

--------------------------------

### View command parameter help

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

Use `aliyun ecs describe-regions --help` to see detailed parameter information for a specific command.

```bash
aliyun ecs describe-regions --help
```

--------------------------------

### View specific command usage with --help

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Use this command to view the usage and parameters of a specific command, such as describe-instances. This is part of the '--help' method for discovering plugin-based commands.

```bash
aliyun ecs describe-instances --help
```

--------------------------------

### 重新加载 systemd 配置并启动服务

Source: https://help.aliyun.com/zh/cli/use-aliyun-mcp-proxy-agent-openapi-mcp-server

重新加载 systemd 配置，启动服务并设置开机自启。

```bash
# 重新加载配置
sudo systemctl daemon-reload
# 启动服务
sudo systemctl start aliyun-mcp-proxy
# 设置开机自启
sudo systemctl enable aliyun-mcp-proxy
```

--------------------------------

### BearerToken: Verify credentials by calling an API

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

After configuration, use this command to call a product API via the plugin to verify the credentials. Replace <command> and <sub-command> with the actual product API.

```bash
aliyun <command> <sub-command> --profile BearerProfile
```

--------------------------------

### Output of aliyun configure get --profile OAuthProfile

Source: https://help.aliyun.com/zh/cli/configure-credentials

JSON output showing all configuration fields for the OAuthProfile profile. Values are partially masked for security.

```json
{
    "name": "OAuthProfile",
    "mode": "OAuth",
    "access_key_id": "STS.9jYc5erFPDLrwNGWc7Sob2ZRHenhHfz7pw9*************",
    "access_key_secret": "3AcNFz37QykuHEwgzWramXGZaCrM1mDHpG1s7v******",
    "sts_token": "CAIS5gJ1q6Ft5DqyfSjI2KnsKI/Rn5lx846Zd******",
    "region_id": "cn-hangzhou",
    "output_format": "json",
    "language": "zh",
    "sts_expiration": 1776751437,
    "oauth_access_token": "eyJhbGciOiJSUzI1NiIsI*******",
    "oauth_refresh_token": "ALGuHPAmSWxR5ynSsoRXhWpUtsxXHcLpGLnZqVvVXZDkjcbMsMasoshv1MnyRhkTq******",
    "oauth_access_token_expire": 1776751436,
    "oauth_site_type": "CN"
}
```

--------------------------------

### 交互式配置 OIDC 凭证

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

使用 aliyun configure --mode OIDC --profile <ProfileName> 命令开始交互式配置，按提示输入 OIDC Provider ARN、Token 文件路径、RAM 角色 ARN 等信息。

```bash
aliyun configure --mode OIDC --profile <ProfileName>
```

--------------------------------

### BearerToken: Non-interactive configuration with default header

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

Configures a BearerToken profile non-interactively. Requires CLI version >= 3.3.16 and the product plugin installed. The default header key is x-acs-bearer-token.

```bash
aliyun configure set \
  --mode BearerToken \
  --profile BearerProfile \
  --bearer-token <your-bearer-token> \
  --region cn-shanghai
```

--------------------------------

### 判断 OpenAPI 风格：ROA 风格帮助

Source: https://help.aliyun.com/zh/cli/understanding-command-structure

通过 aliyun <command> <sub-command> --help 查看参数详情，ROA 风格帮助信息会额外显示请求方式 Method 和访问路径 PathPattern。

```bash
# ROA风格
aliyun cs AttachInstances --help
```

--------------------------------

### Multi-line heredoc parameter passing

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Use a heredoc to pass a long JSON parameter for better readability. The example shows the 'run-instances' command with a system disk configuration passed via a heredoc.

```bash
aliyun ecs run-instances \
  --region cn-hangzhou \
  --instance-type ecs.g7.large \
  --image-id ubuntu_22_04_x64_20G_alibase_20230China.vhd \
  --security-group-id sg-xxx \
  --vswitch-id vsw-xxx \
  --system-disk "$(cat <<'EOF'
{"Size":40,"Category":"cloud_essd","PerformanceLevel":"PL1"}
EOF
)"
```

--------------------------------

### Linux: 确认 aliyun 可执行文件路径

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

使用 which aliyun 确认可执行文件路径，为后续删除做准备。

```bash
which aliyun
```

--------------------------------

### aliyun configure set --profile default --region cn-shanghai - Example

Source: https://help.aliyun.com/zh/cli/configure-credentials

Changes the default region of the 'default' profile to cn-shanghai. After modification, this profile automatically becomes the active profile.

```bash
aliyun configure set --profile default --region cn-shanghai
```

--------------------------------

### 调用DescribeImages查询复制镜像状态（目标地域）

Source: https://help.aliyun.com/zh/cli/use-alibaba-cloud-cli-to-migrate-ecs-instances-across-regions

使用阿里云CLI调用DescribeImages接口，在目标地域查询复制镜像的创建状态，并通过--waiter参数等待镜像状态变为Available。

```shell
aliyun ecs DescribeImages \
  --RegionId 'cn-beijing' \
  --ImageId 'm-bp1h46wfpjsjastd****' \
  --Status 'Creating,Available' \
  --output cols='ImageId,Status' rows='Images.Image[]' \
  --waiter expr='Images.Image[0].Status' to='Available'
```

--------------------------------

### 交互式更新阿里云 CLI：aliyun upgrade

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

v3.3.5 及以上版本支持此命令，一键更新到最新版本。该命令适用于非 Homebrew 安装方式的 CLI。执行时需要确认。

```bash
aliyun upgrade
```

--------------------------------

### Old version command with complex JSON parameters

Source: https://help.aliyun.com/zh/cli/migrating-from-older-versions-to-plug-in-versions-of-cli

Example of the old CLI version for adding backend servers with complex JSON parameters. The command uses camelCase parameter names and the 'AddBackendServers' API.

```bash
aliyun slb AddBackendServers \
  --LoadBalancerId lb-xxx \
  --BackendServers '[{"ServerId":"i-aaa","Weight":100},{"ServerId":"i-bbb","Weight":80}]'
```

--------------------------------

### 创建Dockerfile（Alpine Linux）

Source: https://help.aliyun.com/zh/cli/run-alibaba-cloud-cli-in-a-docker-container

用于构建包含阿里云CLI的Alpine镜像。额外添加jq工具以JSON格式输出，并创建lib64动态链接库软连接。注意：Alpine需要额外创建lib64软连接。

```dockerfile
FROM alpine:latest

# 添加 jq，以 JSON 的格式输出
RUN apk add --no-cache jq

# 获取并安装阿里云 CLI 工具
# 下载阿里云CLI安装包
RUN wget https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz
# 解压安装包
RUN tar -xvzf aliyun-cli-linux-latest-amd64.tgz
# 删除安装包
RUN rm aliyun-cli-linux-latest-amd64.tgz
# 移动可执行文件aliyun至/usr/local/bin目录下
RUN mv aliyun /usr/local/bin/

# 注意：alpine需要额外创建 lib64 的动态链接库软连接
RUN mkdir /lib64 && ln -s /lib/libc.musl-x86_64.so.1 /lib64/ld-linux-x86-64.so.2
```

--------------------------------

### Non-interactive ChainableRamRoleArn configuration in PowerShell

Source: https://help.aliyun.com/zh/cli/ram-role-credentials

PowerShell command example for non-interactive configuration. The --source-profile must already exist in the CLI configuration file, otherwise an error 'can not load the source profile: <name>' occurs.

```powershell
aliyun configure set `
  --profile ChainProfile `
  --mode ChainableRamRoleArn `
  --region cn-hangzhou `
  --source-profile EcsRoleProfile `
  --ram-role-arn acs:ram::<UID>:role/<RoleName> `
  --role-session-name chain-session `
  --expired-seconds 900
```

--------------------------------

### Non-interactive ChainableRamRoleArn configuration in Bash

Source: https://help.aliyun.com/zh/cli/ram-role-credentials

Bash command example for non-interactive configuration. The --source-profile must already exist in the CLI configuration file, otherwise an error 'can not load the source profile: <name>' occurs.

```bash
aliyun configure set `
  --profile ChainableProfile `
  --mode ChainableRamRoleArn `
  --source-profile RamRoleArnProfile `
  --sts-region "cn-hangzhou" `
  --ram-role-arn "acs:ram::012345678910****:role/Alice" `
  --role-session-name "alice" `
  --external-id "abcd1234" `
  --expired-seconds 900 `
  --region "cn-shanghai"
```

--------------------------------

### 删除 config.json 文件（Linux/macOS）

Source: https://help.aliyun.com/zh/cli/configure-credentials

解决上述报错的方法之一：手动删除 `config.json` 文件，然后执行 `aliyun configure` 重新配置凭证。此命令适用于 Linux 或 macOS 系统。

```bash
rm ~/.aliyun/config.json
```

--------------------------------

### 非交互式配置 OIDC 凭证

Source: https://help.aliyun.com/zh/cli/other-credentials-oidc-cloudsso-external-credentialsuri-bearertoken

使用 aliyun configure set 命令，通过环境变量 ALIBABA_CLOUD_OIDC_PROVIDER_ARN、ALIBABA_CLOUD_OIDC_TOKEN_FILE 和 ALIBABA_CLOUD_ROLE_ARN 配置 OIDC 凭证。适用于已启用 RRSA 并安装 ack-pod-identity-webhook 组件的场景。

```bash
aliyun configure set \
  --mode OIDC \
  --profile OIDCProfile \
  --oidc-provider-arn $ALIBABA_CLOUD_OIDC_PROVIDER_ARN \
  --oidc-token-file $ALIBABA_CLOUD_OIDC_TOKEN_FILE \
  --ram-role-arn $ALIBABA_CLOUD_ROLE_ARN \
  --role-session-name "rrsa-pod" \
  --region cn-shanghai
```

--------------------------------

### Shell Special Characters in Parameter Values

Source: https://help.aliyun.com/zh/cli/understanding-command-line-parameters

Values containing shell special characters ($, backtick, backslash, spaces) must be quoted. Use single quotes on Linux/macOS/PowerShell and double quotes on Windows CMD. The example shows quoting a value with a space and a literal dollar sign.

```shell
# Linux/macOS/PowerShell
aliyun ecs describe-images --image-name 'Example Image'
# Windows CMD
aliyun ecs describe-images --image-name "Example Image"

# Linux/macOS
aliyun xxx --param '$literal_dollar'
```

--------------------------------

### 调用DescribeImages查询镜像状态（源地域）

Source: https://help.aliyun.com/zh/cli/use-alibaba-cloud-cli-to-migrate-ecs-instances-across-regions

使用阿里云CLI调用DescribeImages接口，查询自定义镜像的创建状态，并通过--waiter参数等待镜像状态变为Available。

```shell
aliyun ecs DescribeImages \
  --RegionId 'cn-hangzhou' \
  --ImageId 'm-bp146shijn7hujku****' \
  --Status 'Creating,Available' \
  --output cols='ImageId,Status' rows='Images.Image[]' \
  --waiter expr='Images.Image[0].Status' to='Available'
```

--------------------------------

### 查看 AI 模式配置

Source: https://help.aliyun.com/zh/cli/ai-mode

执行 `aliyun configure ai-mode show` 命令查看当前 AI 模式配置，输出为 JSON 格式，包含 enabled、user_agent、effective_user_agent、request_user_agent_suffix 和 config_file 字段。

```bash
aliyun configure ai-mode show
```

```json
{
  "enabled": true,
  "user_agent": "",
  "effective_user_agent": "AlibabaCloud-Agent-Skills",
  "request_user_agent_suffix": "AlibabaCloud-AIMode/enabled AlibabaCloud-Agent-Skills",
  "config_file": "/home/user/.aliyun/ai-mode.json"
}
```

--------------------------------

### 使用 --cli-dry-run 验证命令

Source: https://help.aliyun.com/zh/cli/control-how-api-calls-are-executed

布尔开关，加上即生效，无需赋值。CLI 构造完整请求，打印请求详情但不发送到服务端。

```bash
aliyun ecs describe-instances --biz-region-id cn-hangzhou --cli-dry-run
```

--------------------------------

### 查看已安装插件列表

Source: https://help.aliyun.com/zh/cli/managing-and-using-cli-plugins

使用plugin list命令确认已安装的插件。

```bash
Name                Version             Description
----                -------             -----------
aliyun-cli-ecs      0.1.0               Aliyun CLI plugin for Elastic Compute Service operations.
aliyun-cli-fc       0.1.0               Aliyun CLI plugin for Function Compute 3.0 operations.
```

--------------------------------

### 启用和禁用 AI 模式（命令）

Source: https://help.aliyun.com/zh/cli/ai-mode

使用 `aliyun configure ai-mode enable` 和 `aliyun configure ai-mode disable` 命令全局启用或禁用 AI 模式。

```bash
# 启用 AI 模式
aliyun configure ai-mode enable

# 禁用 AI 模式
aliyun configure ai-mode disable
```

--------------------------------

### Linux: 删除 aliyun 可执行文件

Source: https://help.aliyun.com/zh/cli/install-update-alibaba-cloud-cli

确认路径无误后，使用 sudo rm -v $(which aliyun) 删除该文件。

```bash
sudo rm -v $(which aliyun)
```
Tokens:
Raw