オブジェクト表現を取得するために、クライアントはオブジェクト参照に対する HTTP 要求を送信します。

セキュリティ

API クライアントとサーバ間の HTTP リンクは、SSL を使用して確立されます。API クライアントは、サーバと通信するためのトークン ベースの認証を構成します。

図 1. シナリオ：ID 123 のアラートに関する詳細を取得するためのユーザー認証情報を入力します。
有効な認証情報により保護されたエンドポイント
トークンベースの認証では、 vRealize Operations API サーバにログイン要求を送信し、有効なユーザー認証情報を指定して認証トークンを取得します。次の例は、トークンベースの認証シナリオを示しています。
  1. vRealize Operations インスタンスの有効なユーザー認証情報を取得します。
  2. 認証のために REST エンドポイントに要求を送信します。 
    https://RESTendpoint.example.com/suite-api/api/auth/token/acquire

    要求本文には、ユーザー名、パスワード、および認証ソースが含まれています。

  3. エンドポイントは応答本文で、トークン、有効期限、および時間を返します。
  4. より詳細な通信を行うには、次の形式でトークン オブジェクトを認証ヘッダーに含めます。 
    Authorization: vRealizeOpsToken <vROps_token>
    または、SSO ソースからトークンを取得した場合、認証ヘッダーの形式は次のようになります。 
    Authorization: SSO2Token <SSO_SAML_TOKEN>
  5. ログアウト エンドポイントに POST 要求を送信することにより、有効期限が切れる前にトークンを無効にすることができます。 
    POST https://RESTendpoint.example.com/suite-api/api/auth/token/release

要求ヘッダー

通常、次の HTTP ヘッダーが API 要求に含まれています。
Accept-Language 応答に必要な言語を指定するには、Accept-Language の要求ヘッダーを使用します。ErrorType 応答のメッセージ文字列はローカライズされています。フランス語にローカライズされたメッセージ文字列の応答を要求するには、次のヘッダーを使用します。 
Accept-Language: fr-FR
認証 API セッションを作成するすべての要求には、組織が使用する ID プロバイダによって規定されたフォームの Authorization ヘッダーを含める必要があります。
Content-Type 本文を含む要求には、適切な HTTP Content-Type ヘッダーを含める必要があります。
  • XML 形式の要求本文の場合、ヘッダーに Content-Type: application/xml を含める必要があります。
  • JSON 形式の要求本文の場合、ヘッダーに Content-Type: application/json を含める必要があります。
受け入れる 適切な応答形式を指定するには、Accept 要求ヘッダーを含めます。
  • XML 形式の応答の場合、ヘッダーに Accept: application/xml を含める必要があります。
  • JSON 形式の応答の場合、ヘッダーに Accept: application/json を含める必要があります。

XML 形式の要求本文

XML で記述された要求本文の場合、vRealize Operations では、要求本文内の要素の順序と数値がスキーマと一致することを要求する検証 XML パーサが使用されます。要求本文は、次の基準を満たしていない限り、無効として拒否されます。

  • 要求内の要素で表されるすべての名前空間に対して XML 名前空間属性を指定する必要があります。
  • 要求に複数の名前空間が示されている場合、XML 名前空間属性には識別プリフィックスを含め、名前空間のすべての要素についてこのプリフィックスを使用する必要があります。
  • 必要なすべての要素が要求本文に示されている必要があります。要求本文に含まれるすべての要素は、スキーマに指定されている型制約に準拠するコンテンツとともに、スキーマによって設定されている順序で示されている必要があります。