Installer et configurer oapi-cli

Vous pouvez gérer vos ressources du Cloud OUTSCALE avec oapi-cli, une interface en ligne de commande (CLI) développée par 3DS OUTSCALE.

oapi-cli est exclusivement compatible avec l’API OUTSCALE. C’est le successeur d’OSC CLI, avec des fonctionnalités enrichies et une expérience utilisateur améliorée. Pour en savoir plus, voir Comparaison entre OSC CLI et oapi-cli.

Vous pouvez aussi utiliser Cockpit, OSC CLI, ou AWS CLI. Pour en savoir plus, voir À propos de Cockpit, Installer et configurer OSC CLI, et Installer et configurer AWS CLI.

Installer oapi-cli

Installer oapi-cli sur Linux

  1. Téléchargez le fichier oapi-cli-x86_64.AppImage en utilisant la commande suivante :

    $ curl -LO https://github.com/outscale/oapi-cli/releases/download/nightly-linux/oapi-cli-x86_64.AppImage

  2. Rendez le fichier exécutable en utilisant la commande suivante :

    $ chmod a+x ./oapi-cli-x86_64.AppImage

  3. Vous pouvez maintenant lancer oapi-cli comme suit :

    $ ./oapi-cli-x86_64.AppImage

    Si vous rencontrez une erreur fuse, installez fuse.

    Si vous ne pouvez pas installer fuse, lancez oapi-cli-x86_64.AppImage avec l’option --appimage-extract-and-run :

    $ ./oapi-cli-x86_64.AppImage --appimage-extract-and-run ReadImages

    Cette commande va extraire le contenu du fichier dans un répertoire temporaire et l’exécuter. Notez qu’utiliser cette méthode prend beaucoup plus de temps qu’utiliser fuse.

  4. (optionnel) Pour rendre oapi-cli accessible à tous les utilisateurs, déplacez le fichier comme suit :

    $ sudo mv oapi-cli-x86_64.AppImage /usr/local/bin/oapi-cli

Installer oapi-cli sur macOS

Avant de commencer : Installez Homebrew sur votre machine.

  1. Lancez les commandes suivantes dans votre terminal :

    $ brew tap outscale/tap
$ brew install outscale/tap/oapi-cli

  2. Vous pouvez maintenant lancer oapi-cli comme suit :

    $ oapi-cli

Installer oapi-cli sur Windows

  1. Téléchargez oapi-cli-x86_64.zip et extrayez le contenu du fichier.

  2. Vous pouvez maintenant lancer oapi-cli comme suit :

    $ oapi-cli.exe

Configurer oapi-cli

  1. (Linux et macOS) Dans votre répertoire home, créez un répertoire .osc.

  2. Créez un fichier nommé config.json avec le contenu suivant :

    {
    "default": {
        "access_key": "ACCESSKEY",
        "secret_key": "SECRETKEY",
        "region": "eu-west-2"
    }
}

    où :

    • eu-west-2 est la Région de votre compte.

    • ACCESSKEY et SECRETKEY sont l’ID d’access key et la secret key correspondante de votre compte. Pour en savoir plus, voir Créer une access key.

  3. (Linux et macOS) Enregistrez ce fichier dans le répertoire .osc.
    (Windows) Enregistrez ce fichier dans le même répertoire que oapi-cli.exe.

  4. Vous pouvez maintenant exécuter des requêtes d’API avec oapi-cli.

Pour des options de configuration plus avancées, voir le dépôt GitHub d’oapi-cli.

Utiliser oapi-cli

Pour envoyer une requête avec oapi-cli, spécifiez dans votre commande :

  • La requête que vous demandez.

  • Toute autre option attendue par la commande.

Exemple de requête
$ oapi-cli CreateVolume \
   --SubregionName eu-west-2a \
   --Size 10

Avec OSC CLI, vous devez spécifier le nom de l’API dans votre commande (par exemple, api ou fcu). Ceci n’est pas nécessaire avec oapi-cli, puisque oapi-cli n’est compatible qu’avec l’API OUTSCALE.

Utiliser des syntaxes alternatives

Vous pouvez utiliser différentes syntaxes pour envoyer des requêtes avec oapi-cli. Les exemples suivants se basent sur la requête CreateTags pour illustrer les syntaxes possibles pour les arguments complexes.

Syntaxe similaire à OSC CLI
$ oapi-cli CreateTags \
    --ResourceIds '["i-11111111", "i-22222222"]'  \
    --Tags '[{"Key": "key", "Value": "example1"}]'
Syntaxe alternative pour les paramètres imbriqués
$ oapi-cli CreateTags \
    --ResourceIds '["i-11111111", "i-22222222"]' \
    --Tags.0.Key key \
    --Tags.0.Value example2
Notation en cascade pour les paramètres imbriqués
$ oapi-cli CreateTags \
    --ResourceIds '["i-11111111", "i-22222222"]' \
    --Tags.0.Key key ..Value example3
Notation en crochets pour les tableaux
$ oapi-cli CreateTags \
    --ResourceIds[] "i-11111111" \
    --ResourceIds[] "i-22222222"  \
    --Tags.0.Key key ..Value example4

Pour exécuter une commande avec la notation en crochets, certains shells (comme zsh) nécessitent l’ajout de guillemets autour de l’option.

Exemple de requête
$ oapi-cli CreateTags \
    "--ResourceIds[]" "i-11111111" \
    "--Tags.0.Key" key ..Value example4

Pages connexes

AWS™ et Amazon Web Services™ sont des marques de commerce d'Amazon Technologies, Inc. ou de ses affiliées aux États-Unis et/ou dans les autres pays.

Exporter en PDF