Los clientes de API de VMware Aria Operations implementan un flujo de trabajo de REST, realizando solicitudes HTTP al servidor y recuperando la información que necesitan de las respuestas del servidor.

Acerca de REST

REST, acrónimo para Transferencia de Estado Representacional, describe una característica de estilo arquitectónico de los programas que utilizan el protocolo de transferencia de hipertexto (HTTP) para intercambiar representaciones serializadas de objetos entre un cliente y un servidor. En la API de VMware Aria Operations, estas representaciones son documentos JSON o XML.

En un flujo de trabajo de REST, las representaciones de los objetos se transfieren entre un cliente y un servidor con la hipótesis explícita de que ninguna parte necesita saber nada sobre un objeto que no sea lo que se presenta en una solicitud o respuesta únicas. Las URL en las que están disponibles estos documentos a menudo persisten más allá de la duración de la solicitud o la respuesta que las incluye.

Flujo de trabajo de REST API

Los programas de aplicaciones escritos para usar una REST API utilizan solicitudes HTTP que se ejecutan a menudo mediante un script u otro lenguaje de nivel superior para realizar llamadas de procedimiento remoto que crean, recuperan, actualizan o eliminan objetos que define la API. En la REST API de VMware Aria Operations, estos objetos se definen mediante una colección de esquemas XML. Las operaciones en sí son solicitudes HTTP y, por tanto, son genéricas para todos los clientes HTTP.

Para escribir una aplicación cliente de REST API, debe comprender solo el protocolo HTTP y la semántica de JSON o XML, así como el formato de transferencia que utiliza la API de VMware Aria Operations. Para utilizar la API de forma efectiva en dicho cliente, debe familiarizarse con los siguientes conceptos.

  • El conjunto de objetos que admite la API y lo que representan.
  • Cómo representa la API estos objetos.
  • El modo en el que un cliente hace referencia a un objeto en el cual desea operar.

La referencia de API incluye una lista completa de las solicitudes de API. Consulte Acceder a la documentación de Swagger para referencia de esquema.