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 utilise une structure de commande unifiée basée sur des plugins. Cette rubrique décrit les composants d'une commande et explique comment utiliser --help pour afficher rapidement les commandes et paramètres disponibles.

Prérequis

Alibaba Cloud CLI version 3.3.0 ou ultérieure est installée. Pour plus d'informations, consultez la page Installation, mise à jour et désinstallation d'Alibaba Cloud CLI.
Un identifiant est configuré pour Alibaba Cloud CLI. Pour plus d'informations, consultez la page Configuration et gestion des identifiants.

Format des commandes

Format des commandes CLI basé sur les plugins

La structure générale des commandes d'Alibaba Cloud CLI, basée sur les plugins, se présente comme suit :

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

Description de chaque composant :

command : commande de premier niveau, qui peut être de l'un des deux types suivants :
- Commandes intégrées (aucune installation de plugin requise). Par exemple :
  - configure (configurer les identifiants et les paramètres par défaut).
  - plugin (gérer les plugins).
  - upgrade (mettre à jour la CLI).
  Exécutez aliyun --help pour afficher toutes les commandes intégrées.
- Noms des plugins de produits cloud. Par exemple, aliyun-cli-ecs, aliyun-cli-oss, aliyun-cli-cs et aliyun-cli-fc.
sub-command : sous-commande (SubCommand) qui spécifie l'opération à effectuer.
- Lorsque la commande de premier niveau est une commande intégrée, exécutez aliyun <command> --help pour afficher les paramètres ou sous-commandes disponibles.
- Lorsque la commande de premier niveau est un plugin de produit cloud, les sous-commandes utilisent la convention kebab-case. Par exemple, describe-instances et create-bucket.
parameters : paramètres de commande qui contrôlent le comportement d'Alibaba Cloud CLI ou spécifient les paramètres de l'API. Pour plus d'informations sur les formats de paramètres, consultez la page Présentation des paramètres de commande.
- Paramètres métier : préfixés par --. Par exemple, --instance-id i-xxx.
- Paramètres globaux : paramètres communs qui affectent le comportement global de la commande. Par exemple, --region cn-hangzhou et --profile prod.

Exemple minimal

La commande suivante interroge la liste des régions accessibles au compte actuel et ne nécessite aucun paramètre supplémentaire :

aliyun ecs describe-regions

Chargement des plugins à la demande

Les plugins CLI sont des ensembles de commandes de produits cloud distribués indépendamment et prennent en charge l'installation automatique à la demande :

Lister les plugins installés :
```
aliyun plugin list
```

Installation automatique lors de la première exécution (comportement par défaut pour CLI ≥ 3.3.0) :

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

Installer manuellement un plugin spécifique :
```
aliyun plugin install --names ecs
```

Pour plus d'opérations de gestion des plugins, consultez la page Gestion et utilisation des plugins Alibaba Cloud CLI.

Ancien format des commandes CLI (style OpenAPI)

Important

À partir de la version 3.3.0, Alibaba Cloud CLI a introduit des commandes basées sur des plugins (style kebab-case, telles que aliyun ecs describe-regions), remplaçant les anciennes commandes PascalCase (telles que aliyun ecs DescribeRegions). Afin de garantir l'exhaustivité des fonctionnalités et la stabilité à long terme, nous vous recommandons vivement de migrer vos scripts existants et vos opérations quotidiennes vers les commandes basées sur des plugins.

Les opérations OpenAPI d'Alibaba Cloud utilisent deux styles : RPC et ROA. La plupart des services utilisent le style RPC. La méthode d'appel diffère entre les deux styles. Avant d'utiliser les anciennes commandes de style OpenAPI, vous devez déterminer le style de l'API. En général, toutes les API d'un produit utilisent le même style et chaque API ne prend en charge qu'un style spécifique. Pour plus d'informations sur les styles RPC et ROA, consultez la page Styles OpenAPI.

Structure des commandes de style RPC

Lorsque la commande de premier niveau est un code de produit et que le produit utilise le style RPC, la sous-commande correspond généralement au nom de l'opération OpenAPI. La structure de la commande est la suivante :

aliyun <ProductCode> <APIName> [Parameters]

Exemple : interroger la liste des régions disponibles.

aliyun ecs DescribeRegions

Structure des commandes de style ROA

Les opérations OpenAPI de style ROA nécessitent une méthode HTTP supplémentaire Method et un chemin de requête PathPattern. La structure de la commande est la suivante :

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

L'exemple suivant montre comment appeler l'API Container Service for Kubernetes (ACK) DescribeClustersForRegion pour interroger les clusters dédiés ACK dans la région Chine (Hangzhou).

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

La sortie d'aide pour les opérations OpenAPI de style ROA affiche également la méthode HTTP Method et le chemin de requête PathPattern afin de confirmer le format d'appel.

Déterminer le style OpenAPI

Vous pouvez déterminer le style de l'API en utilisant les méthodes suivantes :

Ajoutez --help après aliyun <command> pour obtenir la liste des opérations OpenAPI disponibles. La sortie d'aide pour les opérations de style RPC affiche les descriptions des opérations, tandis que la sortie d'aide pour les opérations de style ROA affiche le chemin de requête PathPattern. Par exemple :
```
# RPC style
aliyun ecs --help
```
Ajoutez --help après aliyun <command> <sub-command> pour afficher les détails des paramètres. La sortie d'aide pour les opérations de style ROA affiche également la méthode HTTP Method et le chemin de requête PathPattern. Par exemple :
```
# ROA style
aliyun cs AttachInstances --help
```

Remarque

À partir de la CLI 3.3.0, après l'installation d'un plugin de produit cloud, la commande aliyun <command> --help affiche par défaut les informations d'aide du plugin. Pour afficher l'aide d'origine, définissez la variable d'environnement ALIBABA_CLOUD_ORIGINAL_PRODUCT_HELP=true. Le comportement de la sous-commande aliyun <command> <sub-command> --help reste inchangé.

Utilisation de l'aide des commandes

Alibaba Cloud CLI propose trois niveaux de navigation avec --help. Ajoutez --help après un nom de plugin (tel que ecs) ou une sous-commande pour afficher la liste des sous-commandes disponibles et les détails des paramètres.

Lister les commandes intégrées et les plugins pris en charge

aliyun --help

Lister toutes les sous-commandes

aliyun ecs --help

Afficher les détails des paramètres

Affiche la liste des paramètres, indique si chaque paramètre est obligatoire, ainsi que son type de données, sa valeur par défaut et des exemples pour la sous-commande spécifiée :

aliyun ecs describe-instances --help

Indicateurs clés dans la sortie d'aide

|
**Indicateur**
|
**Description**
| | --- | --- | |
`[Required]`
|
Paramètre obligatoire
| |
Annotation de type
|
Type de données du paramètre, tel que String, Integer, Boolean, Array ou JSON
| |
Valeur par défaut
|
Par exemple, `--output json` (la valeur par défaut est json)
| |
Extrait d'exemple
|
Généralement situé à la fin de la sortie d'aide, montrant des modèles d'invocation typiques
|

FAQ

L'exécution d'une commande renvoie « Command not found »

Cette erreur indique que le plugin de produit cloud correspondant n'est pas installé. La CLI ≥ 3.3.0 prend en charge l'installation automatique lors de la première exécution. Si l'installation automatique échoue en raison de restrictions réseau, exécutez manuellement la commande suivante pour installer le plugin :

aliyun plugin install --names ecs

Comment afficher les paramètres pris en charge par une sous-commande

Exécutez aliyun <command> <sub-command> --help pour afficher la liste complète des paramètres.