Anforderungen versenden und Antworten empfangen können Sie mit einem Browser oder einem HTTP-Clientprogramm.

REST-Clientprogramme

Jede Clientanwendung, die HTTPS-Anforderungen versenden kann, ist ein geeignetes Tool zur Entwicklung von REST-Anwendungen mit der VMware Aria Operations-API. Für die meisten Browser und viele IDEs stehen REST-Clients als Plug-ins zur Verfügung. Folgende Open-Source-Programme werden häufig verwendet:

  • cURL. http://curl.haxx.se
  • Die Anwendung Postman. http://www.getpostman.com

Außerdem stellt VMware sprachspezifische Client-Bindings für die VMware Aria Operations-API bereit.

Informationen zur Schemareferenz

Die Dokumentation der REST API für VMware Aria Operations enthält Referenzmaterial für alle Elemente, Typen, Abfragen und Vorgänge in der VMware Aria Operations-API. Sie enthält auch die Dateien mit den Schemadefinitionen.

Die Swagger-basierte API-Dokumentation ist zusammen mit dem Produkt erhältlich, mit der Möglichkeit, REST-API-Aufrufe direkt von der Startseite aus durchzuführen.

Verwenden Sie für den Zugriff auf die API-Dokumentation die URL Ihres VMware Aria Operations-Cloud-Proxys. Wenn die URL Ihres Cloud-Proxys beispielsweise https://www.cloudproxy.vmware.com ist, finden Sie die API-Referenz unter: https://cloudproxy.vmware.com/suite-api/doc/swagger-ui.html.
Hinweis: Sie müssen Ihre Cloud-Proxy-IP oder Ihren FQDN in der URL verwenden, um auf die API-Dokumentation zuzugreifen.

Sprachspezifische Client-Bindings finden Sie unter: 

https://www.cloudproxy.vmware.com/vrops-cloud/suite-api/

Autorisieren der VMware Aria Operations-API

Um API-Aufrufe durchzuführen, müssen Sie Ihren VMware Aria Operations-Cloud-Proxy in der Swagger-Benutzeroberfläche mithilfe des Zugriffstokens autorisieren. Geben Sie den Wert CSP-Token (apiKey) ein und klicken Sie auf Autorisieren.

Informationen zu den API-Beispielen für VMware Aria Operations

Alle Beispiele enthalten HTTP-Anforderungen und HTTP-Antworten. Diese Beispiele zeigen den mit Vorgängen, wie z. B. der Erzeugung von Objekten in Ihrer überwachten Umgebung und der Abfrage diesbezüglicher Informationen, verbundenen Workflow und Inhalt.

Die Texte der Beispielanforderungen sind in JSON. Die von der VMware Aria Operations-API verlangten Kopfzeilen der Anforderungen sind in den Beispielanforderungen enthalten, die keine Fragmente eines größeren Beispiels sind.

In den meisten Beispielantworten werden nur die für den jeweils behandelten Vorgang relevanten Elemente und Attribute angezeigt. Die Auslassungspunkte (...) zeigen an, dass Inhalte im Antworttext ausgelassen wurden.