Search <book_title>...

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

Last Published: 2017-11-06

Product(s): NetBackup & Alta Data Protection (8.1)

NBWSS を介した API 呼び出し

NetBackup WebSocket サービス (NBWSS) では、クラウドベースのアプリケーションはセキュア接続を介して NetBackup に対する REST API 呼び出しを実行できます。クラウドアプリケーションは、JSON (JavaScript Object Notation) 形式でメッセージを NBWSS に送信します。JSON メッセージには、クラウドアプリケーションが実行する REST API 呼び出しが含まれます。次に、NBWSS はクラウドアプリケーションの代わりに API 呼び出しを行い、そのアプリケーションに応答を返送します。

NetBackup の REST API 呼び出しを行う要求の例を次に示します。

{ 
      "version": "1.0",
      "id": "9CD2B69F-0BBF-3F60-974D-C1F2EF37B872",
      "type": "COMMAND",
      "subType": "REQUEST",
      "timeStamp": 1444806222,
      "payload": {
            "uri": "/netbackup/config/servers/vmservers/vCenter1.domain
                    .com",
            "method": "GET",
            "headers": {
                  "Content-Type": "application/vnd.netbackup+json;version=1.0"
            }
      }
}

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

API 呼び出しを行うには、"type" フィールドが "COMMAND"、"subType" フィールドが "REQUEST" である必要があります。
"payload" フィールドは呼び出される API の種類によって異なります。
- この例では、"uri" フィールドに REST API 呼び出しの URI が含まれています。NBWSS はホスト名とポートが完全な REST 要求に含まれていることを確認します。
- "method" フィールドには、実行する API 呼び出しの種類が含まれます。この例では、"GET" (vCenter1 に関する情報を取得する要求) です。
- "headers" フィールドには、API 呼び出しに含める HTTP ヘッダーが含まれます。この例の "Content-Type" は、要求が JSON 形式で送信されることを示す "application/vnd.netbackup+json;version=1.0" に設定されています。
- "Content-Type" の形式は次のとおりです。
```
"Content-Type": "application/vnd.netbackup+media;version=<major>.<minor>"
```
  メモ:
  "Content-Type" 内のバージョン番号 (version=<major>. <minor>) は、変更がメジャーかマイナーかに応じて、将来のリリースで変更される可能性があります。

次の項では、NBWSS メッセージの例を示します。

NBWSS メッセージの例を参照してください。