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

NBWSS 通知

NetBackup が NBWSS エンドポイントに接続すると、そのエンドポイントは NetBackup から NOTIFICATION REQUEST メッセージの形式で通知を受信します。エンドポイントは、通知を受信するときに、 NOTFICATION RESPONSE メッセージで応答する必要があります。

表: NetBackup 通知の種類 では、NetBackup が送信する通知の種類について説明します。

A. 通知要求

NetBackup は NOTIFICATION REQUEST メッセージの形式で通知をエンドポイントに送信します。このメッセージには、ペイロードに 1 つ以上の通知が含まれる場合があります。

通知要求の例を次に示します。

{
      "version": "1.0",
      "id": "EDD85CD7-8553-47E4-8A19-01C65092F220",
      "type": "NOTIFICATION",
      "subType": "REQUEST",
      "timeStamp": 1459811679,
      "payload": [
            {
                  "notificationType": "INFO",
                  "object": "JOB",
                  "data": [
                        {
                              "scheduleType": "ST_FULL",
                              "clientName": "mserver2.acme.com",
                              "status": 0,
                              "startTime": 1459829674,
                              "state": "ACTIVE",
                              "policyName": "vmware2",
                              "parentJobId": 144,
                              "jobId": 144,
                              "policyType": "VMWARE",
                              "jobType": "BACKUP"
                        }
                  ]
            }
      ]
}

要求メッセージでは、"payload" 値の種類はアレイです。アレイの各要素には、異なる通知オブジェクトタイプ ("JOB" または "IMAGE") が保持されます 。要素には、該当のオブジェクトタイプに関連するすべての通知が含まれます。このアレイにより、NetBackup は同様の通知をまとめてバッチ処理できます。

たとえば、ジョブの開始と終了の場合、ペイロードには 1 つの要素 ("JOB" という通知オブジェクトタイプ) が含まれます。"JOB" 通知オブジェクトのデータセクション内には、各通知に 1 つずつの合わせて 2 つの要素が存在します。1 つのメッセージにバッチ処理された通知の例については、次の項の「1 つのメッセージ内の複数の通知」を参照してください。

その他の NetBackup 通知メッセージを参照してください。

B. 通知応答

各通知要求に対して、NOTIFICATION RESPONSE メッセージが予期されます。この応答の "id" フィールドは、要求の "id" と同じで、"payload" フィールドが空のアレイである必要があります。

例:

 {
      "version": "1.0",
      "id": "EDD85CD7-8553-47E4-8A19-01C65092F220",
      "type": "NOTIFICATION",
      "subType": "RESPONSE",
      "timeStamp": 1445036999,
      "payload": []
}

NetBackup が応答を受信すると、要求内で送信された通知が確認されたと見なされ、新しい通知が発生したときに送信可能になります。通知要求が設定期間内に確認されなかった場合、通知が再送信されます。通知が確認されるまで、そのエンドポイントには新しい通知が送信されません。

この期間は、nbwss.properties ファイルで notification.scheduledRate オプションを使って設定できます。デフォルトは 5 秒です。次の項では、nbwss.properties ファイルのオプションについて詳しく説明します。

NetBackup WebSocket サービス (NBWSS) のプロパティの設定を参照してください。

NetBackup は、配信の問題を避けるため、NetBackup とエンドポイント間の接続が切断した場合、エンドポイントサーバーがオフラインになった場合、NetBackup Web サービスで問題が発生した場合でも通知の配信を保証します。エンドポイントサーバーがオフラインになった場合、通知はそのサーバーグループの次のエンドポイントサーバーに送信されます。

クラウドアプリケーションへの NetBackup 接続に関する注意事項を参照してください。