Use Alibaba Cloud CLI to call the OOS API - CloudOps Orchestration Service

Alibaba Cloud CLI est un outil de ligne de commande polyvalent développé sur la base d'OpenAPI Explorer. Utilisez Alibaba Cloud CLI pour automatiser la gestion et la maintenance dans CloudOps Orchestration Service. Cette rubrique explique comment utiliser Alibaba Cloud CLI pour appeler l'API CloudOps Orchestration Service à l'aide de plusieurs exemples.

Avant de commencer

Pour plus d'informations sur Alibaba Cloud CLI, consultez Présentation d'Alibaba Cloud CLI

Installer Alibaba Cloud CLI

Installez Alibaba Cloud CLI avant de l'utiliser. L'installation est possible sous Windows, Linux et macOS. Sélectionnez le package d'installation adapté au système d'exploitation de votre appareil. Pour plus d'informations, reportez-vous aux rubriques suivantes :

Windows : Installation d'Alibaba Cloud CLI sous Windows
Linux : Installation, mise à jour et désinstallation d'Alibaba Cloud CLI
macOS : Installation d'Alibaba Cloud CLI sous macOS

Vous pouvez également utiliser Cloud Shell fourni par Alibaba Cloud pour déboguer les commandes que vous souhaitez exécuter dans Alibaba Cloud CLI. Pour en savoir plus sur Cloud Shell, consultez Présentation de Cloud Shell

Configurer Alibaba Cloud CLI

Important

Un compte Alibaba Cloud dispose des autorisations nécessaires pour gérer et accéder aux API de tous les services Alibaba Cloud. L'utilisation d'un compte Alibaba Cloud pour appeler des opérations d'API peut engendrer des risques de sécurité. Nous vous recommandons de créer et d'utiliser un utilisateur RAM (Resource Access Management) pour appeler des opérations d'API ou effectuer des opérations courantes d'O&M.

Avant d'utiliser Alibaba Cloud CLI, configurez certaines informations, telles que les identifiants et l'ID de région. Alibaba Cloud CLI prend en charge divers types d'identifiants. Pour plus d'informations, consultez la section « Types d'identifiants » de la rubrique Configurer les identifiants. Dans cet exemple, nous utilisons des identifiants AccessKey. Procédez comme suit :

Créez un utilisateur RAM et accordez-lui les autorisations de gestion des services Alibaba Cloud selon vos besoins métier. Pour plus d'informations, consultez Créer un utilisateur RAM et Utiliser RAM pour le contrôle d'accès.
Générez une paire de clés AccessKey pour l'utilisateur RAM et notez l'AccessKey ID ainsi que l'AccessKey secret pour la configuration ultérieure des identifiants. Pour plus d'informations, consultez Créer une clé AccessKey.
Spécifiez un ID de région. Alibaba Cloud CLI appelle les opérations d'API dans la région spécifiée. Pour obtenir la liste des régions disponibles, consultez Endpoints.

Remarque
Lorsque vous utilisez Alibaba Cloud CLI, spécifiez l'option --region pour exécuter une commande dans une région spécifique. Si vous définissez cette option, Alibaba Cloud CLI ignore les informations de région contenues dans les configurations d'identification par défaut et les paramètres de variable d'environnement. Pour plus d'informations, consultez Options de ligne de commande.
Utilisez la paire de clés AccessKey de l'utilisateur RAM pour configurer les identifiants AccessKey dans le fichier de configuration nommé AkProfile. Pour plus d'informations, consultez la section « Exemples de configuration » de la rubrique Configurer les identifiants.

Générer une commande CLI

Accédez à la page Débogage des API d'OOS.
Dans la zone de recherche située à gauche de la page de débogage des API, recherchez l'opération d'API que vous souhaitez appeler. Dans l'onglet Parameters de l'opération d'API, spécifiez les paramètres conformément à la référence de l'API. Cliquez sur l'onglet CLI Example à droite pour afficher l'exemple de commande généré contenant les paramètres spécifiés.
- Cliquez sur l'icône pour lancer Cloud Shell et déboguer la commande dans Cloud Shell.
- Cliquez sur l'icône pour copier l'exemple de commande dans le presse-papiers. Collez ensuite l'exemple de commande dans votre shell local pour l'exécuter.
  - Veillez à respecter les formats des paramètres lorsque vous collez l'exemple de commande dans votre shell local pour le débogage. Pour plus d'informations sur les formats de paramètres dans les commandes Alibaba Cloud CLI, consultez Comprendre les paramètres de commande.
  - Par défaut, l'option --region est ajoutée à l'exemple de commande généré dans OpenAPI Explorer. Lorsque vous copiez la commande dans votre shell local, Alibaba Cloud CLI ignore les informations de région contenues dans les configurations d'identification par défaut et les paramètres de variable d'environnement, et exécute la commande en priorité dans la région spécifiée. Vous pouvez supprimer ou conserver cette option selon vos besoins métier.

Appeler des opérations d'API

Syntaxe

Dans Alibaba Cloud CLI, utilisez la syntaxe suivante pour exécuter des commandes. Pour plus d'informations, consultez la section « Syntaxe » de la rubrique Générer et exécuter des commandes CLI.

aliyun <command> <subcommand> [options and parameters]

Options de commande courantes

Lorsque vous utilisez Alibaba Cloud CLI, spécifiez des options de commande pour modifier le comportement des commandes ou activer des fonctionnalités étendues. Les options de commande courantes suivantes sont utilisées :

--profile <profileName> : Utilisez l'option --profile et le paramètre profileName pour spécifier un profil de configuration. Après avoir spécifié un profil de configuration valide, Alibaba Cloud CLI ignore les informations contenues dans les configurations d'identification par défaut et les paramètres de variable d'environnement, et utilise en priorité les configurations que vous avez spécifiées pour exécuter les commandes.
--help : Utilisez l'option --help pour obtenir les informations d'aide relatives à une commande. Pour plus d'informations, consultez Utiliser la commande d'aide.

Pour plus d'informations, consultez Options de ligne de commande.

Exemple de code

Exemple 1 : Le code suivant illustre l'utilisation de l'option --help pour obtenir la liste des opérations d'API CloudOps Orchestration Service prises en charge par Alibaba Cloud CLI. Vous pouvez également consulter les opérations d'API pouvant être appelées dans la rubrique Vue d'ensemble des API.

Exécutez la commande suivante :
```
aliyun oos --help
```
Consultez le résultat.

Exemple 2 : Le code suivant montre comment utiliser Alibaba Cloud CLI pour appeler l'opération CreateTemplate d'OOS afin de créer un modèle nommé CLI_Template.

Exécutez la commande suivante :

Remarque

Le format d'entrée des paramètres de type liste de tableaux JSON varie selon votre système d'exploitation. Choisissez et exécutez la commande correspondante en fonction de votre système d'exploitation. Pour plus d'informations, consultez Comprendre les paramètres de commande.

Linux/macOS

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content '{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}'

Windows

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content "{'FormatVersion': 'OOS-2019-06-01', 'Description': 'Describe instances of given status', 'Parameters': {'Status': {'Type': 'String', 'Description': '(Required) The status of the Ecs instance.'}}, 'Tasks': [{'Properties': {'Parameters': {'Status': '{{ Status }}'}, 'API': 'DescribeInstances', 'Service': 'Ecs'}, 'Name': 'foo', 'Action': 'ACS::ExecuteApi'}]}"

Consultez le résultat.

{
  "RequestId": "989F0944-E653-5826-9FA7-8ADE6E66F485",
  "Template": {
    "Description": "Describe instances of given status",
    "CreatedBy": "test(2039927162697*****)",
    "TemplateFormat": "JSON",
    "ResourceGroupId": "rg-acfmykd6*****",
    "UpdatedDate": "2024-08-05T10:28:24Z",
    "TemplateVersion": "v1",
    "Hash": "8abc5921b5a05051992*****",
    "UpdatedBy": "test(2039927162697*****)",
    "HasTrigger": false,
    "CreatedDate": "2024-08-05T10:28:24Z",
    "TemplateName": "CLI_Template",
    "Tags": {},
    "TemplateId": "t-9246d5246f*****",
    "ShareType": "Private"
  }
}

Remarque

Si une erreur est renvoyée après l'appel d'une opération d'API CloudOps Orchestration Service, vérifiez la validité des paramètres et des valeurs d'entrée en vous basant sur le code d'erreur.

Vous pouvez également utiliser la plateforme Alibaba Cloud OpenAPI Diagnostics pour effectuer un autodiagnostic basé sur l'ID de demande renvoyé ou les informations d'erreur.