Search <book_title>...

Guide de référence de Veritas NetBackup™ WebSocket Service (NBWSS)

Last Published: 2018-03-28

Product(s): NetBackup (8.1.1)

Formats de message NBWSS

Pour communiquer avec les terminaux client WebSocket, le NetBackup WebSocket Service (NBWSS) utilise son propre format de message avec la JavaScript Object Notation (JSON). Le format JSON permet à NBWSS et aux applications sur les terminaux client d'effectuer le suivi des messages par ID et de déterminer leur type et sous-type.

Les messages fonctionnent sous forme de demande et de réponse : chaque demande a une réponse associée.

Voici ci-dessous un exemple d'une demande de connexion NBWSS :

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

Un exemple de réponse d'une application :

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

Prenez en compte les éléments suivants :

Le message commence par une accolade gauche ({}) et se termine par une accolade droite (}).
La réponse doit avoir la même valeur pour « id » que pour la demande.
Les entrées se composent de paires clé : valeur qui sont séparées par une virgule.
Le message comprend une charge utile. Pour les messages de type SE CONNECTER ou COMMANDE, la charge utile contient un objet entre les accolades {}. Pour les messages de type NOTIFICATION, la charge utile contient une baie de disques entre les crochets [].
Pour la tâche en arrière-plan sur le formatage JSON, consultez la note de groupe de travail réseau sur JavaScript Object Notation :
http://www.ietf.org/rfc/rfc4627.txt?number=4627

Tableau : Champs de message NBWSS décrit les champs dans les messages NBWSS.

Tableau : Champs de message NBWSS

Clé	Description
`version:`	La version du message. Dans cette version, la version disponible est `1.0`.
`id:`	Un identificateur unique pour le message. Quand NBWSS envoie un message de demande, un UUID est généré et est inséré dans ce champ. Lorsque l'application au niveau des terminaux client répond avec un message de réponse, NBWSS attend la réponse pour contenir le même ID que le message de demande. L'ID permet à NBWSS de mapper le message de demande pour le message de réponse. Quand NBWSS reçoit un message de demande, son message de réponse contient le même ID que le message de demande. L'ID permet à l'application de terminal client de mapper la demande pour la réponse si nécessaire.
`type :`	Le type de message. Les types disponibles sont : `CONNEXION` Pour demander une connexion à un terminal client. `COMMANDE` Pour demander l'exécution d'un appel de REST API. `NOTIFICATION` Pour générer un rapport sur l'état des événements NetBackup, tels que l'état d'un travail de sauvegarde.
`Sous-type :`	Le sous-type du message. Les sous-types disponibles sont `DEMANDE` ou `RÉPONSE`.
`horodatage :`	Une représentation numérique de la durée de l'époque UNIX (en secondes) lorsque le message est envoyé.
`charge utile :`	Le corps du message. Le corps du message varie en fonction du type et du sous-type du message. Les rubriques suivantes incluent de plus amples détails et exemples : Se reporter à Appels d'API sur NBWSS. Se reporter à Notifications de NBWSS. Se reporter à Exemples de messages NBWSS.