Les clients d'API VMware Aria Operations mettent en œuvre un workflow REST, en envoyant des demandes HTTP au serveur et en récupérant les informations dont ils ont besoin à partir des réponses du serveur.

À propos de REST

REST, acronyme de Representational State Transfer, décrit une caractéristique de style architectural des programmes qui utilisent le protocole HTTP (Hypertext Transfer Protocol) pour échanger des représentations sérialisées d'objets entre un client et un serveur. Dans l'API VMware Aria Operations, ces représentations sont des documents JSON ou XML.

Dans un workflow REST, les représentations d'objets sont échangées entre un client et un serveur sur le principe explicite qu'aucune des parties n'a besoin d'en savoir plus sur un objet que ce qui est présenté dans une demande ou une réponse unique. Les URL auxquelles ces documents sont disponibles sont souvent conservées au-delà de la durée de vie de la demande ou de la réponse qui les comprend.

Workflows REST API

Les programmes d'application écrits pour utiliser REST API utilisent des demandes HTTP fréquemment exécutées par un script ou un autre langage de niveau supérieur pour effectuer des appels de procédure distante qui créent, récupèrent, mettent à jour ou suppriment des objets définis par l'API. Dans REST API VMware Aria Operations, ces objets sont définis par un ensemble de schémas XML. Les opérations elles-mêmes sont des demandes HTTP et sont donc génériques pour tous les clients HTTP.

Pour écrire une application client REST API, vous devez comprendre uniquement le protocole HTTP et la sémantique de JSON ou XML, c'est-à-dire le format de transfert que l'API VMware Aria Operations utilise. Pour utiliser efficacement l'API dans ce type de client, vous devez vous familiariser avec les concepts suivants.

  • L'ensemble des objets pris en charge par l'API et ce qu'ils représentent.
  • La façon dont l'API représente ces objets.
  • La façon dont un client fait référence à un objet qu'il souhaite utiliser.

La référence d'API comprend une liste complète de demandes d'API. Reportez-vous à Accès à la documentation Swagger pour la référence de schéma.