Veritas NetBackup™ WebSocket 服务 (NBWSS) 参考指南

Last Published:
Product(s): NetBackup & Alta Data Protection (8.1.1)

NBWSS 消息格式

要与 WebSocket 端点进行通信，NetBackup WebSocket Service (NBWSS) 需将其自己的消息格式与 JavaScript 对象表示法 (JSON) 结合使用。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 的消息，负载包含以大括号 { } 括住的对象。对于类型为 NOTIFICATION 的消息，负载包含以方括号 [ ] 括住的阵列。

  • 有关 JSON 格式的背景知识，请参见 JavaScript 对象表示法的相关“网络工作组”备忘录：

    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 Epoch 时间（以秒为单位）的数字表示形式。

payload:

消息正文。正文因消息的类型和子类型而异。

以下主题包含更多详细信息和示例：

请参见通过 NBWSS 执行 API 调用。

请参见NBWSS 通知。

请参见NBWSS 消息示例。