REST API-Aufrufe

Das ztC Edge-System unterstützt die folgenden REST API-Aufrufe (REST = Representational State Transfer; API = Application Program Interface):

login

Stellt die Anmeldeinformationen für den Zugriff auf Ressourceninformationen bereit. Dieser Autorisierungsaufruf verhindert, dass nicht autorisierte Benutzer auf das System zugreifen. Geben Sie zuerst diesen Aufruf aus, kopieren Sie den Wert von session-id aus der JSON-Zeichenfolge der Antwort und verwenden Sie diesen Wert als JSESSIONID im Header zukünftiger Aufrufe.
Header Wert Erforderlich
Inhaltstyp application/json Ja
Anfrage Wert Erforderlich
Benutzername Der Benutzername für die Anmeldung bei der ztC Console. Ja
Kennwort Das Kennwort für Benutzername. Ja

Endpunkt

Das Folgende ist der Endpunkt mit einer Basis-URL /restapi:

POST /login

Beispiel

Anfrage-URL:

https://{hostname or IP address}/restapi/login

overview

Ruft Systeminformationen ab, darunter Eigenschaften der physischen Maschine, Statistiken, Systemleistung sowie eine aktuelle Meldungsliste. Die Antwort kann relativ groß sein (ca. 14 KB).
Header Wert Erforderlich
Sprache de (Deutsch), en-US (Englisch), ja (Japanisch), zh-CN (Chinesisch) oder pt-br (Portugiesisch). Die Standardsprachversion ist en-US. Nein
Inhaltstyp application/json Ja

Endpunkt

GET /system/overview

Beispiel

Anfrage-URL:

https://{hostname or IP address}/restapi/system/overview

vms

Ruft eine Liste der im System vorhandenen VMs ab.

Header Wert Erforderlich
JSESSIONID Wert von session-id in der Antwort auf den login-Aufruf Ja
Inhaltstyp application/json Ja

Endpunkt

GET /v1/vms

Beispiel

Anfrage-URL:

https://{hostname or IP address}/restapi/v1/vms