Veritas NetBackup™ WebSocket 服务 (NBWSS) 参考指南
NBWSS 通知
当 NetBackup 连接到某个 NBWSS 端点时，该端点会以 NOTIFICATION REQUEST 消息的形式接收来自 NetBackup 的通知。当端点收到通知时，其应使用 NOTFICATION RESPONSE 消息进行响应。
表：NetBackup 通知类型介绍了 NetBackup 发送的通知类型。
表：NetBackup 通知类型
|
通知类型 |
描述 |
|---|---|
|
NetBackup 作业通知 |
作业启动时，NetBackup 会发出有关作业当前状态（"QUEUED"、"ACTIVE" 或 "DONE"）的通知。请注意，NetBackup 会定期轮询作业状态。 作业完成后，NetBackup 会发出作业状态为 "DONE" 的通知。不管作业是成功还是失败，NetBackup 都会发出此通知。 |
|
NetBackup 备份映像通知 |
创建备份映像时，NetBackup 会发出映像状态为 "CREATE" 或 "UPDATE" 的通知。 更新备份映像时，NetBackup 会发出映像状态为 "UPDATE" 的通知。 删除备份映像时，NetBackup 会发出映像状态为 "DELETE" 的通知。 当映像副本失效时，如果剩余的所有本地副本均为无法还原的复制副本，NetBackup 则会发出通知 "NO_LOCAL_COPY_AVAILABLE"。 |
A. 通知请求
NetBackup 以 NOTIFICATION REQUEST 消息的形式向端点发送通知。此消息可能在其负载内具有一个或多个通知。
下面是通知请求的一个示例：
{
"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 对类型相似的通知一起进行批处理。
例如，对于开始作业和已完成的作业，负载具有一个元素：类型为 "JOB" 的通知对象。在 "JOB" 通知对象的数据部分中，有两个元素，每个元素代表一个通知。有关在一个消息中经过批处理的通知的示例，请参见以下主题中的“一个消息中的多个通知”：
每个通知对象都具有以下字段：
notificationType:显示通知类型的字符串。在此版本中，只有一个类型 "INFO"。
object:显示通知对象的字符串。在此版本中，只有对象 "JOB" 和 "IMAGE"。
data:包含每个对象类型的信息的阵列。每个数据阵列元素都是单独的通知。数据阵列中的字段特定于每个通知类型。
请参见NBWSS 消息示例。
B. 通知响应
对于每个通知请求，都应有一个 NOTIFICATION RESPONSE 消息。此响应的 "id" 字段应与请求的 "id" 相同，而且 "payload" 字段应为空阵列。
例如：
{
"version": "1.0",
"id": "EDD85CD7-8553-47E4-8A19-01C65092F220",
"type": "NOTIFICATION",
"subType": "RESPONSE",
"timeStamp": 1445036999,
"payload": []
}当 NetBackup 收到响应时，在请求内发送的通知会被视为已确认，随后可在出现新通知时进行发送。如果通知请求未在配置的时间段内加以确认，将会重新发送通知。在通知得到确认之前，不会向该端点发送任何新通知。
可以通过 notification.scheduledRate 选项在 nbwss.properties 文件中配置该时间段。默认值为 5 秒。以下主题包含有关 nbwss.properties 文件中的选项的详细信息：
请参见配置 NetBackup WebSocket Service (NBWSS) 的属性。
为避免传送问题，NetBackup 保证在下列情况下传送通知：NetBackup 与端点之间的连接断开、端点服务器脱机或 NetBackup Web 服务出现问题。如果端点服务器脱机，通知将转到服务器组中的下一个端点服务器。