Use Alibaba Cloud CLI to obtain the help information - - Centro de documentación de Alibaba Cloud

Alibaba Cloud CLI se integra con los servicios de Alibaba Cloud y su información de API. Agregue la opción --help en Alibaba Cloud CLI para obtener la información de ayuda.

Consultar los servicios disponibles y las opciones globales

Agregue la opción --help al comando aliyun para consultar las opciones comunes de los comandos y los servicios compatibles.

Ejecute el siguiente comando:
```
aliyun --help
```

Respuesta de ejemplo (parcial):

shell@Alicloud:~$ aliyun --help
Alibaba Cloud CLI 3.0.276

Usage:
  aliyun <product> <operation> [--parameter1 value1 --parameter2 value2 ...]

Flags:
  --mode                    Use `--mode {AK|StsToken|RamRoleArn|EcsRamRole|RsaKeyPair|RamRoleArnWithRoleName}` to specify an authentication method.
  --profile,-p              Use `--profile <profileName>` to specify a profile.
  ...
  --help                    Print the help information.

Sample:
  aliyun ecs DescribeRegions

Products:
  actiontrail                  ActionTrail
  adb                          AnalyticDB for MySQL
  adcp                         Distributed Cloud Container Platform for Kubernetes
  ...

Consultar las operaciones de API disponibles de un servicio

Agregue la opción --help después del código del servicio para consultar la lista de operaciones de API disponibles en dicho servicio. Se muestran las descripciones de las operaciones de API en remote procedure call (RPC) style. También se muestran los endpoints de las operaciones de API en resource-oriented architecture (ROA) style.

Nota

Alibaba Cloud CLI utiliza los siguientes indicadores antes de la descripción de la operación para señalar su estado o características:

[Anonymous]: indica una operación anónima que se puede invocar sin autenticación. Para invocar este tipo de operación, consulte Generic calls.
[Deprecated]: indica que la operación está obsoleta. Se recomienda cambiar a una versión más reciente de esta operación.

RPC

Ejecute el siguiente comando para consultar las operaciones de API disponibles en Elastic Compute Service (ECS):
```
aliyun ecs --help
```

Respuesta esperada:

shell@Alicloud:~$ aliyun ecs --help
Alibaba Cloud CLI 3.0.276

Usage:
  aliyun ecs <ApiName> --parameter1 value1 --parameter2 value2 ...

Product: Ecs (ECS)
Version: 2014-05-26 

Available Api List: 
  AcceptInquiredSystemEvent                          Accepts and authorizes operations on system events. For system events in the Inquiring state, this operation accepts the default operations for the system events and authorizes the system to perform the default operations. 
  ActivateRouterInterface                            [Deprecated] Activates inactive router interfaces. 
  AddBandwidthPackageIps                             [Deprecated]
  AddTags                                            Adds or overwrites one or more tags for ECS resources. You can add tags to ECS resources such as instances, disks, snapshots, images, and security groups for easy management. 
  ...

ROA

Ejecute el siguiente comando para consultar las operaciones de API disponibles en Container Service for Kubernetes (ACK):
```
aliyun cs --help
```

Respuesta esperada:

shell@Alicloud:~$ aliyun cs --help
Alibaba Cloud CLI 3.0.276

Usage 1:
  aliyun cs [GET|PUT|POST|DELETE] <PathPattern> --body "..." 

Usage 2 (For API with NO PARAMS in PathPattern only.):
  aliyun cs <ApiName> --parameter1 value1 --parameter2 value2 ... --body "..."

Product: CS (ACK)
Version: 2015-12-15 

Available Api List: 
  AttachInstances                         : POST /clusters/[ClusterId]/attach
  AttachInstancesToNodePool               : POST /clusters/[ClusterId]/nodepools/[NodepoolId]/attach
  CancelClusterUpgrade                    : POST /api/v2/clusters/[ClusterId]/upgrade/cancel
  CancelComponentUpgrade                  : POST /clusters/[clusterId]/components/[componentId]/cancel
  ...

Consultar los detalles de los parámetros de una API

Agregue la opción --help después de una operación de API para consultar los detalles de los parámetros, como el nombre y el tipo de cada parámetro. También se muestran el método de solicitud y el endpoint de una operación de API de ROA-style.

RPC

Ejecute el siguiente comando para consultar los detalles de los parámetros de la operación DescribeRegions de Elastic Compute Service:
```
aliyun ecs DescribeRegions --help
```

Respuesta esperada:

shell@Alicloud:~$ aliyun ecs DescribeRegions --help
Alibaba Cloud CLI 3.0.276

Product: Ecs (ECS)

Parameters:
  --AcceptLanguage String  Optional

  The natural language that is used to filter responses. For more information, see RFC7231 at https://tools.ietf.org/html/rfc7231. Valid values:   
           
  - zh-CN: Chinese 
  - en-US: English. 
  - ja: Japanses 
  
  Default value: zh-CN. 

  --InstanceChargeType String  Optional

  The billing method of the instance. For more information, see Billing overview. Valid values: 
  
  - PrePaid: subscription. If you set this parameter to PrePaid, make sure that you have sufficient balance or credits in your account. Otherwise, the InvalidPayMethod error code is returned. 
  - PostPaid: pay-as-you-go. 
  
  Default value: PostPaid. 

  --ResourceType String  Optional

  The type of the resource. Valid values:
  -  instance: ECS instance
  -  disk: disk
  -  reservedinstance: reserved instance
  -  scu: storage capacity unit (SCU)
  
  Default value: instance

ROA

Ejecute el siguiente comando para consultar los detalles de los parámetros de la operación AttachInstances de Container Service for Kubernetes:
```
aliyun cs AttachInstances --help
```

Respuesta esperada:

shell@Alicloud:~$ aliyun cs AttachInstances --help
Alibaba Cloud CLI 3.0.276

Product:     CS (ACK)
Method:      POST
PathPattern: /clusters/[ClusterId]/attach

Parameters:
  --ClusterId String  Required

  The ID of the cluster. 

  --body Struct  Optional

  The request body parameters.