Search <book_title>...

Veritas NetBackup™ WebSocket サービス (NBWSS) リファレンスガイド

Last Published: 2018-03-28

Product(s): NetBackup (8.1.1)

NBWSS メッセージの形式

WebSocket エンドポイントと通信するために、NetBackup WebSocket サービス (NBWSS) は JSON (JavaScript Object Notation) による独自のメッセージ形式を使います。JSON 形式により、NBWSS とエンドポイントのアプリケーションは ID に基づきメッセージを追跡し、メッセージの形式とサブタイプを判別できます。

メッセージは要求と応答として動作します。各要求には関連付けられた応答があります。

NBWSS 接続要求の例を次に示します。

{  
      "version": "1.0",
      "id": "0CEAB6C2-0BBF-4F60-974D-C1F3EF39B872",
      "type": "CONNECT",
      "subType": "REQUEST",
      "timeStamp": 1444944181,
      "payload": {
            "token": "qwerrtrtrtrt2234344==="
      }
}

アプリケーションの応答の例:

{  
      "version": "1.0",
      "id": "0CEAB6C2-0BBF-4F60-974D-C1F3EF39B872",
      "type": "CONNECT",
      "subType": "RESPONSE",
      "timeStamp": 1444944191,
      "payload": {
            "valid": true
      }
}

次の点に注意してください。

メッセージは左側の波括弧 ({) で始まり、右側の波括弧 (}) で終わります。
応答の "id" は要求と同じものである必要があります。
エントリは、カンマで区切った key:value の組み合わせで構成されます。
メッセージには payload が含まれます。CONNECT または COMMAND 形式のメッセージの場合、ペイロードには波括弧 { } で囲んだ object が含まれます。NOTIFICATION のメッセージの場合、ペイロードには角括弧 [ ] で囲んだ array が含まれます。
JSON フォーマットについては、JavaScript Object Notation に関するネットワーキンググループメモを参照してください。
http://www.ietf.org/rfc/rfc4627.txt?number=4627

表: NBWSS メッセージフィールドでは、NBWSS メッセージのフィールドについて説明します。

表: NBWSS メッセージフィールド

キー	説明
`version:`	メッセージのバージョン。このリリースの利用可能なバージョンは `1.0` です。
`id:`	メッセージの一意の識別子。 NBWSS は、要求メッセージを送信するときに UUID を生成し、このフィールドに配置します。エンドポイントのアプリケーションが応答メッセージで応答するとき、NBWSS は応答メッセージが要求メッセージと同じ ID を含んでいることを想定します。この ID により、NBWSS は要求メッセージを応答メッセージにマッピングできます。 NBWSS が要求メッセージを受信する場合、その応答メッセージには要求メッセージと同じ ID が含まれます。この ID により、エンドポイントのアプリケーションは必要に応じて要求を応答にマッピングできます。
`type:`	メッセージの形式。利用可能な形式は次のとおりです。 `CONNECT` エンドポイントへの接続を要求します。 `COMMAND` REST API 呼び出しの実行を要求します。 `NOTIFICATION` バックアップジョブの状態など、NetBackup イベントの状態を報告します。
`subType:`	メッセージのサブタイプ。利用可能なサブタイプは `REQUEST` または `RESPONSE` です。
`timeStamp:`	メッセージが送信された UNIX エポック時間 (秒単位) の数値表現です。
`payload:`	メッセージの本文。本文はメッセージの形式とサブタイプによって異なります。次の項で、より詳しい説明と例を示します。 NBWSS を介した API 呼び出しを参照してください。 NBWSS 通知を参照してください。 NBWSS メッセージの例を参照してください。