Cette page a été traduite par l'API Cloud Translation.

Utiliser l'utilitaire apigee-adminapi.sh

Le apigee-adminapi.sh appelle l'API de gestion Edge pour effectuer de nombreuses tâches de maintenance.

À propos de apigee-adminapi.sh

Avantages

L'avantage de l'utilitaire apigee-adminapi.sh est qu'il:

Utilise une interface de ligne de commande simple
Implémentation de la saisie semi-automatique via des commandes
Fournit de l'aide et des informations sur l'utilisation
Possibilité d'afficher l'appel d'API correspondant si vous décidez d'essayer l'API

Comparaison avec apigee-provision

L'utilitaire apigee-adminapi.sh ne remplace pas l'utilitaire apigee-provision. L'utilitaire apigee-provision utilise en fait l'utilitaire apigee-adminapi.sh pour effectuer ses tâches.

Voici les principales différences entre les deux outils:

apigee-adminapi.sh exécute des fonctions atomiques qui remplacent les appels individuels d'API Edge. Par exemple, la création d'une organisation, d'un environnement et d'un hôte virtuel nécessite trois commandes apigee-adminapi.sh distinctes correspondant à trois appels d'API.
apigee-provision effectue une opération complète de haut niveau via une seule commande. Par exemple, vous pouvez créer une organisation, un environnement et un hôte virtuel à l'aide d'une seule commande apigee-provision en transmettant un fichier de configuration contenant toutes les informations nécessaires.

La documentation Edge utilise les deux utilitaires le cas échéant.

Installer apigee-adminapi.sh

L'utilitaire apigee-adminapi.sh est automatiquement installé lorsque vous installez l'utilitaire apigee-provision ou apigee-validate.

L'utilitaire est installé à l'emplacement suivant:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Appelez apigee-adminapi.sh

Vous appelez apigee-adminapi.sh à partir d'un nœud de serveur de gestion. Lorsque vous appelez l'utilitaire, vous devez définir les éléments suivants en tant que variables d'environnement ou options de ligne de commande:

ADMIN_EMAIL (correspond à l'option de ligne de commande admin)
ADMIN_PASSWORD (pwd)
EDGE_SERVER (host)

L'exemple suivant appelle apigee-adminapi.sh et transmet les valeurs requises en tant qu'options de ligne de commande:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost

L'exemple suivant définit les options requises en tant que variables d'environnement temporaires, puis appelle l'utilitaire apigee-adminapi.sh:

export ADMIN_EMAIL=user@example.com
export ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list

Si vous ne transmettez pas le mot de passe en tant qu'option ou si vous ne le définissez pas en tant que variable d'environnement, apigee-adminapi.sh vous invite à le saisir.

Définir les paramètres apigee-adminapi.sh

Vous devez saisir tous les paramètres d'une commande à l'aide de commutateurs de ligne de commande ou de variables d'environnement. Si nécessaire, ajoutez un seul tiret (-) ou un double tiret (--) devant les commutateurs de ligne de commande.

Par exemple, vous pouvez spécifier le nom de l'organisation de l'une des manières suivantes:

À l'aide du commutateur de ligne de commande -o :

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg

Définir une variable d'environnement nommée ORG :

export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

REMARQUE:Vous utilisez généralement des variables d'environnement pour définir ADMIN_EMAIL et EDGE_SERVER, et éventuellement ADMIN_PASSWORD. Ces paramètres sont utilisés par la plupart des commandes. Le problème lors de la définition d'autres paramètres, tels que ORG, à l'aide de variables d'environnement, c'est qu'ils peuvent être corrects pour une commande, mais qu'ils peuvent l'être pour une commande ultérieure. Par exemple, si vous oubliez de réinitialiser la variable d'environnement, vous risquez de transmettre par inadvertance une valeur incorrecte à la commande suivante.

Si vous omettez des paramètres obligatoires dans la commande, l'utilitaire affiche un message d'erreur décrivant les paramètres manquants. Par exemple, si vous omettez l'option --host (qui correspond à la variable d'environnement EDGE_SERVER), apigee-adminapi.sh renvoie l'erreur suivante:

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

Si une erreur HTTP STATUS CODE: 401 s'affiche, cela signifie que le mot de passe que vous avez saisi est incorrect.

Obtenir de l'aide sur apigee-adminapi.sh

Vous pouvez à tout moment utiliser la touche Tabulation pour afficher une invite répertoriant les options de commande disponibles.

Pour afficher toutes les commandes possibles, appelez l'utilitaire sans aucune option:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Si vous appuyez sur la touche de tabulation après avoir saisi "apigee-adminapi.sh", la liste des options possibles s'affiche:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

La touche Tabulation affiche des options en fonction du contexte de la commande. Si vous appuyez sur la touche de tabulation après avoir saisi:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Vous verrez les options possibles pour exécuter la commande orgs:

add  apis  apps  delete  envs  list  pods  userroles

Utilisez l'option -h pour afficher l'aide de n'importe quelle commande. Par exemple, si vous utilisez l'option -h comme indiqué ci-dessous:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -h

L'utilitaire affiche des informations d'aide complètes pour toutes les options possibles de la commande orgs. Le premier élément de la sortie affiche l'aide associée à la commande orgs add:

+++++++++++++++++++++++++++++++++++++++++++
orgs add
  Required:
    -o ORG Organization name
  Optional:
    -H HEADER add http header in request
    --admin ADMIN_EMAIL admin email address
    --pwd ADMIN_PASSWORD admin password
    --host EDGE_SERVER edge server to make request to
    --port EDGE_PORT port to use for the http request
    --ssl set EDGE_PROTO to https, defaults to http
    --debug ( set in debug mode, turns on verbose in curl )
    -h      Displays Help

Transmettre un fichier à apigee-adminapi.sh

L'utilitaire apigee-adminapi.sh est un wrapper autour de curl. Par conséquent, certaines commandes correspondent à des appels d'API PUT et POST qui acceptent un corps de requête. Par exemple, la création d'un hôte virtuel correspond à un appel d'API POST qui nécessite des informations sur l'hôte virtuel dans le corps de la requête.

Lorsque vous utilisez l'utilitaire apigee-adminapi.sh pour créer un hôte virtuel, ou toute commande nécessitant un corps de requête, vous pouvez transmettre toutes les informations nécessaires sur la ligne de commande, comme indiqué ci-dessous:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005

Vous pouvez également transmettre un fichier contenant les mêmes informations que celles contenues dans le corps de la requête du processus POST. Par exemple, la commande suivante utilise un fichier définissant l'hôte virtuel:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate

Où le fichier vhostcreate contient le corps POST de l'appel. Dans cet exemple, il s'agit d'un corps de requête au format XML:

<VirtualHost name="myVHostUtil">
  <HostAliases>
    <HostAlias>192.168.56.101:9005</HostAlias>
  </HostAliases>
  <Interfaces/>
  <Port>9005</Port>
</VirtualHost>

Afficher les informations de débogage et de l'API

Utilisez l'option --debug de l'utilitaire apigee-adminapi.sh pour afficher des informations détaillées sur la commande. Ces informations incluent la commande curl générée par l'utilitaire apigee-adminapi.sh pour effectuer l'opération.

Par exemple, la commande suivante utilise l'option --debug. Les résultats affichent le résultat de la commande curl sous-jacente en mode détaillé:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code}
  -u ***oo@bar.com:*****     http://localhost:8080/v1/o -d <Organization name="testOrg2"
  type="paid"/>
  * About to connect() to localhost port 8080 (#0)
  *   Trying ::1... connected
  * Connected to localhost (::1) port 8080 (#0)
  * Server auth using Basic with user 'foo@bar.com'
  > POST /v1/o HTTP/1.1
  > Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
  > User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
  Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
  > Host: localhost:8080
  > Accept: */*
  > Content-Type: application/xml
  > Content-Length: 43
  >
  } [data not shown]
  < HTTP/1.1 201 Created
  < Content-Type: application/json
  < Date: Tue, 03 May 2016 02:08:32 GMT
  < Content-Length: 291
  <
  { [data not shown]
  * Connection #0 to host localhost left intact
  * Closing connection #0