
5.2 Rückgabecodes
BeschreibungRückgabecode
Erfolgreiche Ausführung.2xx
Mit Fehlermeldung zurückgegebener clientseitiger Fehler4xx
Mit Fehlermeldung zurückgegebener Appliance-Fehler5xx
HINWEIS: Wenn ein Fehler auftritt, was an dem Rückgabecode 4xx oder 5xx zu erkennen ist,
wird eine ErrorMessage zurückgegeben. Das erwartete Ressourcen-Modell wird nicht
zurückgegeben.
5.3 URI-Format
Alle URIs verweisen auf Ressourcen. Der Client muss keine URIs erstellen oder ändern. Der URI für
eine Ressource ist statisch und besitzt das Format
https://{appl}/rest/Ressourcen-Kategorie/Ressourcen-ID, wobei Folgendes gilt:
https://{appl} Appliance-Adresse
/rest Typ des URI
/Ressourcen-Kategorie Kategorie der Ressource (z. B. server-profiles)
/Ressourcen-Instanz-ID Kennung der spezifischen Ressourcen-Instanz (optional)
5.4 Format des Ressourcen-Modells
Die Ressourcen unterstützen JSON (JavaScript Object Notation) zum Austauschen von Daten über
eine REST-API. Sofern nicht anderweitig im REST-API-Vorgang angegeben, lautet der Standard JSON.
5.5 Anmelden bei der Appliance über REST-APIs
Wenn Sie sich über die REST-API login-sessions bei der Appliance anmelden, wird eine
Sitzungs-ID zurückgegeben. Die Sitzungs-ID wird bei allen nachfolgenden REST-API-Vorgängen im
Header auth verwendet, außer wie unter REST-API-Anforderungsheader vermerkt. Die Sitzungs-ID
ist 24 Stunden lang gültig.
AbmeldenAnmelden
Vorgang
DELETE
API
/rest/login-sessions
Anforderungsheader
auth:{IhreSitzungsID}
REST-API-Anforderungsheader
Anforderungstext
Keiner
Antwort
204 No Content
Vorgang
POST
API
/rest/login-sessions
Anforderungsheader
REST-API-Anforderungsheader
Anforderungstext
{"userName":"IhrBenutzername","password":"IhrKennwort"}
HINWEIS: Dies ist ein Beispiel für eine lokale Anmeldung bei
der Appliance. Bei Einsatz eines Verzeichnisdienstes müssen
die folgenden Attribute hinzugefügt werden: authnHost und
authLoginDomain.
Antwort
Die LoginSessionIdDTO, in der die Sitzungs-ID enthalten ist
64 Verwenden der REST-APIs und anderer Programmierungsschnittstellen
Comentários a estes Manuais