Accédez à l’interface applicative de programmation ou « API » vCloud avec Performance Cloud VMware (NSX-T)
TABLE DES MATIÈRES
- Définitions
- Notes
- Prérequis
- Procédure
- Étape 1 - Créer une nouvelle collection et s'authentifier auprès de l'API
- Étape 2 - Découvrez les versions d'API prises en charge
- Étape 3 - Établir une session
- Créer une session sur vCloud Director à l'aide de l'authentification de base
- Prenez note de la valeur « x-vcloud-authorization »
- Créez une nouvelle clé dans la section « Headers »
- Créer une session sur vCloud Director à l'aide d'un « Bearer Token »
- Tester la requête pour obtenir les informations sur l'organisation
- Étape 4 - Effectuer des requêtes
- Références
Définitions
Pour faciliter la lecture et pour faire correspondre les captures d’écrans, l’acronyme anglais « API » pour « Application Programming Interface» sera utilisé au lieu de la traduction française « interface applicative de programmation ».
Notes
Dans les étapes ci-dessous, nous utilisons le logiciel Postman mais vous pouvez utiliser n'importe quelle plate-forme d'API compatible.
Sherweb ne fournira aucun type de support pour l'utilisation de l'outil mentionné ou de tout autre logiciel tiers. Veuillez consulter le site Web d'assistance du fournisseur du logiciel pour toute demande d'assistance.
Prérequis
Avoir installé le logiciel Postman
Procédure
Étape 1 - Créer une nouvelle collection et s'authentifier auprès de l'API
- Dans Postman, créez une nouvelle collection.
- Donnez un nom à la nouvelle collection et changez le type d'autorisation pour «Basic Auth ».
- Entrez le nom d'utilisateur et le mot de passe et cliquez sur « Save ».
Le nom d'utilisateur à entrer est [nom d'utilisateur Performance Cloud VMware] + [@] + [organisation Performance Cloud VMware]
Exemple: [email protected]@organisation
- Créer une nouvelle demande (« Add a request »).
- Exécutez la requête suivante :
GET https://performancecloud-vdc.sherweb.com/api/versions
- Confirmez que vous êtes correctement authentifié avec la valeur d'autorisation dans l'onglet « Headers ».
Étape 2 - Découvrez les versions d'API prises en charge
Avec la requête précédemment effectuée, validez les versions d'API prises en charge pour vous assurer que vos requêtes d’API sont prises en charge.
Étape 3 - Établir une session
Dans la section « Headers » , créez une nouvelle clé comme celle-ci :
KEY: Accept
VALUE: Application/*+xml;version=35.2
Remarque : la version doit être la dernière version disponible de l'étape 2
Créer une session sur vCloud Director à l'aide de l'authentification de base
Remarque : en utilisant cette méthode avec la valeur « x-vcloud-authorization », la session sera réinitialisée après quelques heures.
Exécutez la requête suivante pour confirmer que vous avez créé avec succès une session sur vCloud Director :
POST https://performancecloud-vdc.sherweb.com/api/sessions
Vous devriez recevoir une réponse « 200 OK » pour confirmer la réussite de celle-ci.
Prenez note de la valeur « x-vcloud-authorization »
Créez une nouvelle clé dans la section « Headers »
KEY: x-vcloud-authorization
VALUE: valeur de l'étape précédente
Créer une session sur vCloud Director à l'aide d'un « Bearer Token »
Dans l'onglet Tests, saisissez les lignes suivantes et cliquez sur « Send » :
var bearer = postman.getResponseHeader("X-VMWARE-VCLOUD-ACCESS-TOKEN")
pm.environment.set("X-VMWARE-VCLOUD-ACCESS-TOKEN",bearer)
Obtenez la valeur “X-VMWARE-VCLOUD-ACCESS-TOKEN”.
Accédez à l'onglet « Authorization ». Remplacez le type d'autorisation « Inherit from parent » par « Bearer Token ».
Entrez la valeur de l'étape précédente et cliquez sur « Save ».
Tester la requête pour obtenir les informations sur l'organisation
Exécutez la requête suivante :
GET https://performancecloud-vdc.sherweb.com/api/org
Le résultat devrait ressembler à ceci :
Étape 4 - Effectuer des requêtes
Voici quelques requêtes à titre d'exemple.
- Pour obtenir le journal listant les changements de l'état des machines virtuelles (mise hors tension/sous tension) :
GET https://performancecloud-vdc.sherweb.com/api/query?type=event&filter=eventType==com/vmware/vcloud/event/vm/change_state
- Pour obtenir le journal listant les tâches sur une machine virtuelle particulière nommée WEB :
GET https://performancecloud-vdc.sherweb.com/api/query?type=task&filter=objectName==WEB
- Si des métadonnées ont été mises en place sur les machines virtuelles, vous pouvez interroger ces métadonnées.
- Pour lister toutes les machines virtuelles dans l'environnement de production :
GET https://performancecloud-vdc.sherweb.com/api/query?type=vm&filter=metadata:Environnement==STRING:Production
- Pour lister toutes les machines virtuelles du département des ventes :
GET https://performancecloud-vdc.sherweb.com/api/query?type=vm&filter=metadata:Department==STRING:Ventes
- Pour lister toutes les machines virtuelles dans l'environnement de production :
Références
https://developer.broadcom.com/