0% ont trouvé ce document utile (0 vote)
0 vues4 pages

Guide API Vrops

Ce document fournit un guide détaillé pour exécuter des tests API sur vROps via Postman, en décrivant les étapes pour l'authentification, la découverte des VMs, l'audit des métriques, et la collecte de données. Chaque API est accompagnée de la méthode HTTP, de l'URL, des en-têtes requis, et des actions à entreprendre. Il souligne également l'importance de gérer le token d'authentification et de libérer la session à la fin du processus.

Transféré par

ettouyjeryasmine
Copyright
© All Rights Reserved
Nous prenons très au sérieux les droits relatifs au contenu. Si vous pensez qu’il s’agit de votre contenu, signalez une atteinte au droit d’auteur ici.
Formats disponibles
Téléchargez aux formats PDF, TXT ou lisez en ligne sur Scribd
0% ont trouvé ce document utile (0 vote)
0 vues4 pages

Guide API Vrops

Ce document fournit un guide détaillé pour exécuter des tests API sur vROps via Postman, en décrivant les étapes pour l'authentification, la découverte des VMs, l'audit des métriques, et la collecte de données. Chaque API est accompagnée de la méthode HTTP, de l'URL, des en-têtes requis, et des actions à entreprendre. Il souligne également l'importance de gérer le token d'authentification et de libérer la session à la fin du processus.

Transféré par

ettouyjeryasmine
Copyright
© All Rights Reserved
Nous prenons très au sérieux les droits relatifs au contenu. Si vous pensez qu’il s’agit de votre contenu, signalez une atteinte au droit d’auteur ici.
Formats disponibles
Téléchargez aux formats PDF, TXT ou lisez en ligne sur Scribd

Guide d'Exécution Pas à Pas : Tests

API vROps via Postman


API 1 : L'Authentification (Générer le Token)
C'est la clé d'entrée. Elle te donne le droit de parler au serveur.

●​ Méthode : POST
●​ URL : [Link]
●​ Onglet Headers :
○​ Content-Type : application/json
○​ Accept : application/json
●​ Onglet Body : Choisir "raw" et le format "JSON", puis coller :
●​ JSON

{
"username": "ton_utilisateur",
"password": "ton_mot_de_passe"
}
●​ Action : Clique sur Send.
●​ Ce que tu dois faire ensuite : Dans la réponse en bas, copie la valeur exacte du
champ "token". Tu en auras besoin pour TOUTES les APIs suivantes.

API 2 : La Découverte (Trouver les UUID des VMs)


Permet de lister uniquement les vraies machines virtuelles VMware.

●​ Méthode : GET
●​ URL :
[Link]
rtualMachine
●​ Onglet Headers :
○​ Authorization : vROpsToken [COLLE_TON_TOKEN_ICI] (ex: vROpsToken
8eb57...)
○​ Accept : application/json
●​ Onglet Body : Sélectionner "none" (C'est un GET, le corps est vide).
●​ Action : Clique sur Send.
●​ Ce que tu dois faire ensuite : Cherche le nom d'une VM cible et copie son
"identifier" (c'est l'UUID, ex: 550e84...).
API 3 : L'Audit des Métriques (Vérifier les "Stat Keys")
C'est l'étape recommandée par le guide (page 16) pour connaître les noms exacts des
métriques (CPU, RAM) utilisés par ta version de vROps.

●​ Méthode : GET
●​ URL :
[Link]
e/statkeys
●​ Onglet Headers :
○​ Authorization : vROpsToken [TON_TOKEN]
○​ Accept : application/json
●​ Onglet Body : Sélectionner "none".
●​ Action : Clique sur Send.
●​ Ce que tu dois faire ensuite : Note les noms exacts des clés. Par exemple, vérifie
si c'est bien "cpu|usage_average" ou "mem|working_set".

API 2.5 : L'Audit des Métriques (Vérifier les "Stat Keys")


Cette étape permet d'obtenir la liste exacte des noms de métriques (CPU, RAM, Disque)
supportés par votre version de vROps pour éviter toute erreur de lecture.

●​ Méthode : GET
●​ URL :
[Link]
e/statkeys
●​ Onglet Headers :
○​ Authorization : vROpsToken [TON_TOKEN]
○​ Accept : application/json
●​ Onglet Body : Sélectionner "none".
●​ Action : Clique sur Send.
●​ Résultat attendu : Tu vas recevoir un dictionnaire JSON de toutes les clés
disponibles.
○​ Vérification : Cherche "cpu|usage_average" ou "mem|working_set" dans la
liste pour confirmer que ce sont bien les noms à utiliser dans l'API 4.

API 3.5 : Vérification de l'état de la ressource (Power State)


Avant de facturer, cette API permet de savoir si la VM est allumée, éteinte ou suspendue.

●​ Méthode : GET
●​ URL :
[Link]
ies
●​ Onglet Headers :
○​ Authorization : vROpsToken [TON_TOKEN]
○​ Accept : application/json
●​ Onglet Body : Sélectionner "none".
●​ Action : Clique sur Send.
●​ Résultat attendu : Dans le JSON, cherche la propriété
summary|runtime|powerState.
○​ Valeur : Si c'est "poweredOff", vous saurez que la consommation est nulle
pour cette période.

API 6 : Prolongation de la Session (Renew Token)


Indispensable si votre script de collecte dure longtemps, pour éviter d'être déconnecté au
milieu du travail.

●​ Méthode : POST
●​ URL : [Link]
●​ Onglet Headers :
○​ Authorization : vROpsToken [TON_TOKEN]
○​ Accept : application/json
●​ Onglet Body : Sélectionner "none".
●​ Action : Clique sur Send.
●​ Résultat attendu : Le serveur renvoie le même token avec une date d'expiration
(Validity) prolongé[Link] données existent et si la machine est active avant de
générer une facture.

API 4 : La Collecte des Données (Récupérer les chiffres)


C'est ici que tu obtiens les statistiques réelles pour un identifiant donné.

●​ Méthode : GET
●​ URL :
[Link]
test?statKey=cpu|usage_average&statKey=mem|working_set
●​ (Attention : Remplace [COLLE_L_UUID...] par l'identifiant trouvé à l'API 2, et ajuste
les statKey si l'API 3 a montré des noms différents).
●​ Onglet Headers :
○​ Authorization : vROpsToken [TON_TOKEN]
○​ Accept : application/json
●​ Onglet Body : Sélectionner "none".
●​ Action : Clique sur Send.
●​ Résultat attendu : Tu vas recevoir les données avec la date (timestamp) et les
valeurs exactes de consommation pour la facturation.

🌟 API 5 : La Déconnexion (Libérer le Token)


Dans un environnement professionnel, un bon script ne laisse pas ses sessions ouvertes. Il
est recommandé de détruire le token à la fin du processus.

●​ Méthode : DELETE (Attention, on change de méthode !)


●​ URL : [Link]
●​ Onglet Headers :
○​ Authorization : vROpsToken [TON_TOKEN]
●​ Onglet Body : Sélectionner "none".
●​ Action : Clique sur Send.
●​ Résultat attendu : Un code statut HTTP 204 No Content ou 200 OK. Ton token est
maintenant désactivé par sécurité.

Vous aimerez peut-être aussi