:Alibaba Cloud CLI command-line options

Option

Description

--profile,-p

Spécifiez un profil de configuration. Le profil indiqué remplace les paramètres par défaut des identifiants et des variables d'environnement.

Exemple : appelez l'opération DescribeInstances de Elastic Compute Service (ECS) en utilisant le profil akProfile.

aliyun ecs DescribeInstances --profile akProfile

--region

Utilisez --region pour spécifier une région. Cette option remplace la région définie dans les paramètres par défaut des identifiants et des variables d'environnement.

Exemple : appelez l'opération ECS DescribeInstances dans la région cn-beijing.

aliyun ecs DescribeInstances --region cn-beijing

--endpoint

Spécifiez un endpoint. Vous trouverez les endpoints pris en charge dans la section Developer Reference > API Reference > Endpoints de chaque service.

Exemple : appelez l'opération CloudMonitor DescribeMonitorGroups en utilisant l'endpoint metrics.cn-qingdao.aliyuncs.com.

aliyun cms DescribeMonitorGroups --endpoint metrics.cn-qingdao.aliyuncs.com

--endpoint-type

Spécifiez le type d'endpoint. Valeurs valides : vpc (accès VPC) et vide (accès public, valeur par défaut).

Exemple : appelez l'API DescribeInstances d'ECS en utilisant un endpoint VPC.

• Spécification directe dans la ligne de commande

  aliyun ecs DescribeInstances --endpoint-type vpc

• Configuration persistante

  aliyun configure set --endpoint-type vpc
  aliyun ecs DescribeInstances

--version

Spécifiez une version d'API. Doit être utilisée conjointement avec l'option --force. Consultez la rubrique Appel forcé d'une opération d'API.

Exemple : appelez l'opération CloudMonitor DescribeMetricList avec la version d'API 2017-03-01.

aliyun cms QueryMetricList \
      --Project acs_ecs_dashboard \
      --Metric cpu_idle \
      --version 2017-03-01 \
      --force

--header

Ajoute un en-tête de requête. Utilisez cette option plusieurs fois pour ajouter plusieurs en-têtes.

Exemple : ajoutez l'en-tête X-foo=bar.

aliyun <product> <ApiName> --header X-foo=bar

--body

Ajoute une chaîne de caractères en tant que corps de requête pour les appels d'API ROA.

Exemple : appelez l'opération RunClusterCheck de Container Service for Kubernetes (ACK) avec un corps de requête JSON.

aliyun cs POST /clusters/{cluster_id}/checks --body "{\"type\":\"NodePoolUpgrade\",\"target\":\"np1f6779297c4444a3a1cdd29be8e5****\"}"

--body-file

Ajoute un fichier en tant que corps de requête pour les appels d'API RPC. Cette option est prioritaire sur --body.

Exemple : appelez l'opération RunClusterCheck de Container Service for Kubernetes (ACK) avec un corps de requête issu d'un fichier.

aliyun cs POST /clusters/{cluster_id}/checks --body-file /usr/local/bin/example.json

{
    "type": "NodePoolUpgrade",
    "target": "np1f6779297c4444a3a1cdd29be8e5****"
}

--read-timeout

Spécifiez le délai d'attente I/O en secondes. Remplace le délai d'attente I/O par défaut défini dans les paramètres des identifiants.

Exemple : définissez le délai d'attente I/O sur 20 secondes.

aliyun <product> <ApiName> --read-timeout 20

--connect-timeout

Spécifiez le délai d'attente de connexion en secondes. Remplace le délai d'attente de connexion par défaut défini dans les paramètres des identifiants.

Exemple : définissez le délai d'attente de connexion sur 20 secondes.

aliyun <product> <ApiName> --connect-timeout 20

--retry-count

Spécifiez le nombre maximal de tentatives. Remplace le nombre de tentatives par défaut défini dans les paramètres des identifiants.

Exemple : définissez le nombre de tentatives sur 5.

aliyun <product> <ApiName> --retry-count 5

--secure

Force l'utilisation du protocole HTTPS pour la requête. L'opération échoue si l'opération d'API ne prend pas en charge HTTPS.

--insecure

Force l'utilisation du protocole HTTP pour la requête. L'opération échoue si l'opération d'API ne prend pas en charge HTTP.

--quiet,-q

Supprime les résultats de retour de l'API dans la sortie.

--help

Utilisez --help pour afficher l'aide relative à une commande.

Utilisation de la commande d'aide.

--output,-o

Extrait les champs de la réponse OpenAPI et les affiche sous forme de tableau.

Extraction des paramètres et mise en tableau de la sortie.

--pager

Récupère tous les résultats d'une API paginée sans pagination manuelle.

Agrégation des résultats des opérations de pagination.

--force

Force l'appel des opérations d'API et autorise les paramètres non présents dans la liste des métadonnées.

Appel forcé d'une opération d'API.

--waiter

Interroge les résultats de l'API jusqu'à ce qu'un champ spécifié atteigne une valeur cible.

Interrogation des résultats retournés.

--dryrun

Simule un appel d'API et renvoie le résultat sans effectuer d'opérations réelles sur les ressources cloud.

Simulation d'un appel.