Alibaba Cloud CLI uses a plugin-based command structure. Append --help to view available commands and parameters. Version 3.3.0 or later is required for auto plugin loading. - Alibaba Cloud CLI: Central de Documentação do Alibaba Cloud

Pré-requisitos

Alibaba Cloud CLI versão 3.3.0 ou posterior instalado. Para mais informações, consulte Instalar, atualizar e desinstalar o Alibaba Cloud CLI.
Credencial configurada para o Alibaba Cloud CLI. Para mais informações, consulte Configurar e gerenciar credenciais.

Formato do comando

Formato de comando CLI baseado em plugin

A estrutura geral de comandos do Alibaba Cloud CLI baseado em plugins é:

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

Descrição de cada componente:

command: Comando de nível superior. Pode ser um dos dois tipos a seguir:
- Comandos integrados (não exigem instalação de plugin). Exemplo:
  - configure (configura credenciais e parâmetros padrão).
  - plugin (gerencia plugins).
  - upgrade (atualiza o CLI).
  Execute aliyun --help para visualizar todos os comandos integrados.
- Nomes de plugins de produtos de nuvem. Exemplos: aliyun-cli-ecs, aliyun-cli-oss, aliyun-cli-cs e aliyun-cli-fc.
sub-command: Subcomando (SubCommand) que especifica a operação a executar.
- Se o comando de nível superior for integrado, execute aliyun <command> --help para visualizar os parâmetros ou subcomandos disponíveis.
- Se o comando de nível superior for um plugin de produto de nuvem, os subcomandos usam nomenclatura kebab-case. Exemplos: describe-instances e create-bucket.
parameters: Parâmetros que controlam o comportamento do Alibaba Cloud CLI ou especificam parâmetros de API. Para mais informações sobre formatos de parâmetros, consulte Entender os parâmetros de comando.
- Parâmetros de negócio: Prefixados com --. Exemplo: --instance-id i-xxx.
- Parâmetros globais: Parâmetros comuns que afetam o comportamento geral do comando. Exemplos: --region cn-hangzhou e --profile prod.

Exemplo mínimo

O comando a seguir consulta a lista de regiões acessíveis à conta atual sem exigir parâmetros adicionais:

aliyun ecs describe-regions

Carregamento de plugins sob demanda

Os plugins do CLI são conjuntos independentes de comandos de produtos de nuvem com suporte a instalação automática sob demanda:

Liste os plugins instalados:
```
aliyun plugin list
```

Instale automaticamente na primeira execução (comportamento padrão para CLI ≥ 3.3.0):

# If the ecs plugin is not installed, the CLI downloads and caches it automatically.
aliyun ecs describe-instances

Instale manualmente um plugin específico:
```
aliyun plugin install --names ecs
```

Para mais operações de gerenciamento de plugins, consulte Gerenciar e usar plugins do Alibaba Cloud CLI.

Legacy CLI command format (OpenAPI style)

Importante

A partir da versão 3.3.0, o Alibaba Cloud CLI introduziu comandos baseados em plugins (estilo kebab-case, como aliyun ecs describe-regions), substituindo os comandos legados em PascalCase (como aliyun ecs DescribeRegions). Para garantir a integridade dos recursos e a estabilidade a longo prazo, recomendamos migrar scripts existentes e operações diárias para comandos baseados em plugins.

As operações do Alibaba Cloud OpenAPI usam dois estilos: RPC e ROA. A maioria dos serviços adota o estilo RPC. O método de chamada difere entre os dois estilos. Antes de usar comandos legados no estilo OpenAPI, determine o estilo da API. Em geral, todas as APIs de um produto usam o mesmo estilo, e cada API suporta apenas um estilo específico. Para mais informações sobre os estilos RPC e ROA, consulte Estilos do OpenAPI.

Estrutura de comando estilo RPC

Se o comando de nível superior for um código de produto e este usar o estilo RPC, o subcomando geralmente corresponde ao nome da operação OpenAPI. A estrutura do comando é:

aliyun <ProductCode> <APIName> [Parameters]

Exemplo: Consulte a lista de regiões disponíveis.

aliyun ecs DescribeRegions

Estrutura de comando estilo ROA

Operações OpenAPI no estilo ROA exigem um método HTTP adicional Method e caminho de solicitação PathPattern. A estrutura do comando é:

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

O exemplo a seguir mostra como chamar a API DescribeClustersForRegion do Container Service for Kubernetes (ACK) para consultar clusters dedicados do ACK na região China (Hangzhou).

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

A saída de ajuda para operações OpenAPI no estilo ROA também exibe o método HTTP Method e o caminho de solicitação PathPattern para confirmar o formato de chamada.

Determinar o estilo do OpenAPI

Determine o estilo da API usando os métodos a seguir:

Adicione --help após aliyun <command> para obter a lista de operações OpenAPI disponíveis. A saída de ajuda para operações no estilo RPC exibe descrições das operações, enquanto a saída para operações no estilo ROA exibe o caminho de solicitação PathPattern. Exemplo:
```
# RPC style
aliyun ecs --help
```
Adicione --help após aliyun <command> <sub-command> para visualizar detalhes dos parâmetros. A saída de ajuda para operações no estilo ROA também exibe o método HTTP Method e o caminho de solicitação PathPattern. Exemplo:
```
# ROA style
aliyun cs AttachInstances --help
```

Nota

A partir do CLI 3.3.0, após instalar um plugin de produto de nuvem, o comando de nível aliyun <command> --help exibe as informações de ajuda do plugin por padrão. Para visualizar a ajuda original, defina a variável de ambiente ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true. O comportamento do subcomando aliyun <command> <sub-command> --help permanece inalterado.

Uso da ajuda de comandos

O Alibaba Cloud CLI oferece três níveis de detalhamento com --help. Adicione --help após o nome de um plugin (como ecs) ou um subcomando para visualizar a lista de subcomandos disponíveis e detalhes dos parâmetros.

Listar comandos integrados e plugins compatíveis

aliyun --help

Listar todos os subcomandos

aliyun ecs --help

Visualizar detalhes dos parâmetros

Exibe a lista de parâmetros, obrigatoriedade, tipo de dados, valor padrão e exemplos do subcomando especificado:

aliyun ecs describe-instances --help

Marcadores principais na saída de ajuda

Marcador	Descrição
`[Required]`	Parâmetro obrigatório
Anotação de tipo	Tipo de dados do parâmetro, como String, Integer, Boolean, Array ou JSON
Valor padrão	Por exemplo, `--output json` (o padrão é json)
Trecho de exemplo	Geralmente localizado no final da saída de ajuda, mostrando padrões típicos de invocação

Perguntas frequentes

A execução de um comando retorna "Command not found"

Esse erro indica que o plugin do produto de nuvem correspondente não está instalado. O CLI ≥ 3.3.0 suporta instalação automática na primeira execução. Se a instalação automática falhar devido a restrições de rede, execute manualmente o comando a seguir para instalar o plugin:

aliyun plugin install --names ecs

Como visualizar os parâmetros compatíveis com um subcomando

Execute aliyun <command> <sub-command> --help para visualizar a lista completa de parâmetros.