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

Alibaba Cloud CLI utiliza una estructura de comandos unificada basada en plugins. Este tema describe los componentes de un comando y cómo usar --help para consultar rápidamente los comandos y parámetros disponibles.

Requisitos previos

Tener instalada la versión 3.3.0 o posterior de Alibaba Cloud CLI. Para más información, consulte Install, update, and uninstall Alibaba Cloud CLI.
Tener configuradas las credenciales en Alibaba Cloud CLI. Para más información, consulte Configure and manage credentials.

Formato de comandos

Formato de comandos CLI basados en plugins

La estructura general de comandos para Alibaba Cloud CLI basada en plugins es la siguiente:

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

Descripción de cada componente:

command: El comando de nivel superior, que puede ser uno de los dos tipos siguientes:
- Comandos integrados (no requieren instalación de plugins). Por ejemplo:
  - configure (configura credenciales y parámetros predeterminados).
  - plugin (gestiona los plugins).
  - upgrade (actualiza la CLI).
  Ejecute aliyun --help para consultar todos los comandos integrados.
- Nombres de plugins de productos en la nube. Por ejemplo, aliyun-cli-ecs, aliyun-cli-oss, aliyun-cli-cs y aliyun-cli-fc.
sub-command: El subcomando (SubCommand) que especifica la operación a ejecutar.
- Cuando el comando de nivel superior es un comando integrado, ejecute aliyun <command> --help para consultar los parámetros o subcomandos disponibles.
- Cuando el comando de nivel superior es un plugin de producto en la nube, los subcomandos utilizan la convención de nombres kebab-case. Por ejemplo, describe-instances y create-bucket.
parameters: Parámetros del comando que controlan el comportamiento de Alibaba Cloud CLI o especifican parámetros de la API. Para más información sobre los formatos de parámetros, consulte Understand command parameters.
- Parámetros de negocio: Tienen el prefijo --. Por ejemplo, --instance-id i-xxx.
- Parámetros globales: Parámetros comunes que afectan el comportamiento general del comando. Por ejemplo, --region cn-hangzhou y --profile prod.

Ejemplo mínimo

El siguiente comando consulta la lista de regiones accesibles para la cuenta actual y no requiere parámetros adicionales:

aliyun ecs describe-regions

Carga de plugins bajo demanda

Los plugins de la CLI son conjuntos de comandos de productos en la nube distribuidos de forma independiente que admiten la instalación automática bajo demanda:

Listar los plugins instalados:
```
aliyun plugin list
```

Instalación automática en la primera ejecución (comportamiento predeterminado para CLI ≥ 3.3.0):

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

Instalar manualmente un plugin específico:
```
aliyun plugin install --names ecs
```

Para más operaciones de gestión de plugins, consulte Manage and use Alibaba Cloud CLI plugins.

Formato de comandos CLI heredado (estilo OpenAPI)

Importante

A partir de la versión 3.3.0, Alibaba Cloud CLI introdujo comandos basados en plugins (estilo kebab-case, como aliyun ecs describe-regions), que reemplazan a los comandos heredados en PascalCase (como aliyun ecs DescribeRegions). Para garantizar la integridad de las funciones y la estabilidad a largo plazo, se recomienda encarecidamente migrar los scripts existentes y las operaciones diarias a comandos basados en plugins.

Las operaciones de OpenAPI de Alibaba Cloud utilizan dos estilos: RPC y ROA. La mayoría de los servicios usan el estilo RPC. El método de llamada difiere entre ambos estilos. Antes de utilizar comandos heredados con estilo OpenAPI, debe determinar el estilo de la API. Por lo general, todas las API dentro de un producto utilizan el mismo estilo, y cada API admite solo un estilo específico. Para más información sobre los estilos RPC y ROA, consulte OpenAPI styles.

Estructura de comandos estilo RPC

Cuando el comando de nivel superior es un código de producto y este utiliza el estilo RPC, el subcomando suele ser el nombre de la operación de OpenAPI. La estructura del comando es la siguiente:

aliyun <ProductCode> <APIName> [Parameters]

Ejemplo: Consultar la lista de regiones disponibles.

aliyun ecs DescribeRegions

Estructura de comandos estilo ROA

Las operaciones de OpenAPI con estilo ROA requieren un método HTTP adicional Method y una ruta de solicitud PathPattern. La estructura del comando es la siguiente:

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

El siguiente ejemplo muestra cómo llamar a la API DescribeClustersForRegion de Container Service for Kubernetes (ACK) para consultar clústeres dedicados de ACK en la región China (Hangzhou).

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

La salida de ayuda para las operaciones de OpenAPI con estilo ROA también muestra el método HTTP Method y la ruta de solicitud PathPattern para ayudar a confirmar el formato de llamada.

Determinar el estilo de OpenAPI

Puede determinar el estilo de la API mediante los siguientes métodos:

Agregue --help después de aliyun <command> para obtener la lista de operaciones de OpenAPI disponibles. La salida de ayuda para operaciones estilo RPC muestra descripciones de las operaciones, mientras que la salida para operaciones estilo ROA muestra la ruta de solicitud PathPattern. Por ejemplo:
```
# RPC style
aliyun ecs --help
```
Agregue --help después de aliyun <command> <sub-command> para consultar los detalles de los parámetros. La salida de ayuda para operaciones estilo ROA también muestra el método HTTP Method y la ruta de solicitud PathPattern. Por ejemplo:
```
# ROA style
aliyun cs AttachInstances --help
```

Nota

A partir de la versión 3.3.0 de la CLI, tras instalar un plugin de producto en la nube, el comando de nivel aliyun <command> --help muestra la información de ayuda del plugin de forma predeterminada. Para consultar la ayuda original, establezca la variable de entorno ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true. El comportamiento del subcomando aliyun <command> <sub-command> --help permanece sin cambios.

Uso de la ayuda de comandos

Alibaba Cloud CLI ofrece tres niveles de exploración con --help. Agregue --help después del nombre de un plugin (como ecs) o de un subcomando para consultar la lista de subcomandos disponibles y los detalles de los parámetros.

Listar comandos integrados y plugins compatibles

aliyun --help

Listar todos los subcomandos

aliyun ecs --help

Consultar detalles de parámetros

Muestra la lista de parámetros, si cada parámetro es obligatorio, el tipo de datos, el valor predeterminado y ejemplos para el subcomando especificado:

aliyun ecs describe-instances --help

Marcadores clave en la salida de ayuda

Marcador	Descripción
`[Required]`	Parámetro obligatorio
Anotación de tipo	Tipo de datos del parámetro, como String, Integer, Boolean, Array o JSON
Valor predeterminado	Por ejemplo, `--output json` (el valor predeterminado es json)
Fragmento de ejemplo	Generalmente ubicado al final de la salida de ayuda, muestra patrones típicos de invocación

Preguntas frecuentes

Al ejecutar un comando se obtiene "Command not found"

Este error indica que el plugin del producto en la nube correspondiente no está instalado. La CLI ≥ 3.3.0 admite la instalación automática en la primera ejecución. Si la instalación automática falla debido a restricciones de red, ejecute manualmente el siguiente comando para instalar el plugin:

aliyun plugin install --names ecs

Cómo consultar los parámetros admitidos por un subcomando

Ejecute aliyun <command> <sub-command> --help para consultar la lista completa de parámetros.