Use Alibaba Cloud CLI to obtain the help information - - Centre de documentation Alibaba Cloud

L'interface CLI Alibaba Cloud est intégrée aux services Alibaba Cloud et à leurs informations API. Ajoutez l'option --help à l'interface CLI Alibaba Cloud pour obtenir les informations d'aide.

Consulter les services disponibles et les options globales

Ajoutez l'option --help à la commande aliyun pour consulter les options de commande courantes et les services pris en charge.

Exécutez la commande suivante :
```
aliyun --help
```

Réponse type (partielle) :

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
  ...

Consulter les opérations API disponibles pour un service

Ajoutez l'option --help après le code du service pour consulter la liste des opérations API disponibles dans ce service. Les descriptions des opérations API au style RPC (Remote Procedure Call) s'affichent. Les endpoints des opérations API au style ROA (Resource-Oriented Architecture) s'affichent.

Remarque

L'interface CLI Alibaba Cloud utilise les indicateurs suivants avant la description de l'opération pour indiquer l'état ou les caractéristiques de celle-ci :

[Anonymous] : indique une opération anonyme qui peut être appelée sans authentification. Pour appeler ce type d'opération, consultez la section Appels génériques.
[Deprecated] : indique que l'opération est obsolète. Nous vous recommandons de migrer vers une version ultérieure de cette opération.

RPC

Exécutez la commande suivante pour consulter les opérations API disponibles dans le service Elastic Compute Service (ECS) :
```
aliyun ecs --help
```

Réponse attendue :

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

Exécutez la commande suivante pour consulter les opérations API disponibles dans le service Container Service for Kubernetes (ACK) :
```
aliyun cs --help
```

Réponse attendue :

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
  ...

Consulter les détails des paramètres API

Ajoutez l'option --help après une opération API pour consulter les détails des paramètres, y compris le nom et le type du paramètre. La méthode de requête et l'endpoint d'une opération API au style ROA s'affichent également.

RPC

Exécutez la commande suivante pour consulter les détails des paramètres de l'opération DescribeRegions du service Elastic Compute Service :
```
aliyun ecs DescribeRegions --help
```

Réponse attendue :

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

Exécutez la commande suivante pour consulter les détails des paramètres de l'opération AttachInstances du service Container Service for Kubernetes :
```
aliyun cs AttachInstances --help
```

Réponse attendue :

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.