Clients stellen HTTP-Anforderungen an Objektreferenzen, um Objektdarstellungen abzurufen.

Sicherheit

Der HTTP-Link zwischen einem API-Client und dem API-Server wird per SSL hergestellt. API-Clients konfigurieren die Token-Authentifizierung für die Kommunikation mit dem Server.

Abbildung 1. Szenario: Benutzeranmeldedaten angeben, um Informationen zu einer Warnung mit der ID 123 abzurufen
Zugriff auf geschützten Endpoint mit gültigen Anmeldedaten
Bei der Token-Authentifizierung senden Sie eine POST-Anforderung an den API-Server von vRealize Operations Manager API und geben dabei gültige Benutzeranmeldedaten an, um ein Authentifizierungs-Token zu erhalten. Das folgende Beispiel zeigt ein Szenario mit Token-Authentifizierung.
  1. Sie erhalten gültige Benutzeranmeldedaten für Ihre Instanz von vRealize Operations Manager.
  2. Sie senden zur Authentifizierung eine POST-Anforderung an den REST-Endpoint.
    POST https://RESTendpoint.example.com/api/token/acquire

    Der Anforderungstext enthält den Benutzernamen, das Kennwort und die Authentifizierungsquelle.

  3. Im Antworttext gibt der Endpoint das Token, das Ablaufdatum und die Uhrzeit an.
  4. Während der folgenden Kommunikation geben Sie das Token-Objekt jeweils in folgendem Format in der Kopfzeile der Anforderung an:
    Authorization: vRealizeOpsToken <vROps_token>
    Wenn Sie das Token von einer SSO-Quelle erworben haben, hat die Kopfzeile der Autorisierungsheader folgendes Format:
    Authorization: SSO2Token <SSO_SAML_TOKEN>
  5. Sie können das Token vor dem Datum und der Uhrzeit, an dem es abläuft, ungültig machen, indem Sie eine POST-Anforderung an den Abmelde-Endpoint senden.
    POST https://RESTendpoint.example.com/api/token/release

Anforderungskopfzeilen

Die folgenden HTTP-Kopfzeilen sind in der Regel in API-Anforderungen enthalten:
Accept-Language Mit der Anforderungskopfzeile Accept-Language können Sie angeben, in welcher Sprache die Antwort sein soll. Die Zeichenfolgen der Nachrichten in ErrorType-Antworten sind lokalisiert. Mit der folgenden Kopfzeile können Sie eine Antwort anfordern, deren Nachrichten in französischer Sprache lokalisierte Zeichenfolgen enthalten:
Accept-Language: fr-FR
Autorisierung Alle Anforderungen zur Erstellung einer API-Sitzung müssen eine Authorization-Kopfzeile des von dem Identitätsanbieter, den Ihre Organisation verwendet, vorgegebenen Formulars enthalten.
Content-Type Anforderungen mit einem Text müssen eine entsprechende Content-Type-Kopfzeile in HTTP enthalten.
  • Bei einem Anforderungstext in XML muss die Kopfzeile Content-Type: application/xml enthalten.
  • Bei einem Anforderungstext in JSON muss die Kopfzeile Content-Type: application/json enthalten.
Akzeptieren Um das gewünschte Antwortformat anzugeben, können Sie die Anforderung mit der Kopfzeile Accept versehen.
  • Bei einer Antwort in XML muss die Kopfzeile Accept: application/xml enthalten.
  • Bei einer Antwort in JSON muss die Kopfzeile Accept: application/json enthalten.

Anforderungstext in XML

Bei einem in XML geschriebenen Anforderungstext validiert vRealize Operations Manager mit einem XML-Parser, ob die die Reihenfolge und Anzahl der Elemente in einem Anforderungstext mit dem Schema übereinstimmt. Anforderungstexte werden als ungültig zurückgewiesen, wenn sie folgende Kriterien nicht erfüllen:

  • Für alle durch Elemente in der Anforderung dargestellten Namensräume müssen XML-Namensraumattribute angegeben werden.
  • Wenn in der Anforderung mehrere Namensräume dargestellt werden, müssen die XML-Namensraumattribute als Kennung ein Präfix enthalten, das für alle Elemente dieses Namensraums verwendet wird.
  • Alle erforderlichen Elemente müssen im Anforderungstext erscheinen. Für alle Elemente, die im Anforderungstext erscheinen, ist die im Schema vorgesehene Reihenfolge einzuhalten. Für den Inhalt der Elemente gelten die im Schema angegebenen Typenbeschränkungen.