Règles de places réservées

Vous pouvez créer des règles de places réservées pour que les rapports incluent les combinaisons de port et de protocole qui vous intéressent, indépendamment du volume ou du taux de trafic.
nfa1000
Vous pouvez créer des règles de places réservées pour que les rapports incluent les combinaisons de port et de protocole qui vous intéressent, indépendamment du volume ou du taux de trafic.
Cette section explique les opérations prises en charge suivantes sur les règles de places réservées à l'aide de l'API :
Obtenir les règles de places réservées
Cette API vous permet d'obtenir la liste des règles de places réservées.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules
Méthode
GET
Exemple de demande
http://127.0.0.1:8981/odata/api/reservedSeatingRules
Exemple de réponse
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#reservedSeatingRules(ID,protocol,port,description)", "value": [ { "protocol": 6, "port": 4444, "description": "Reserved Seating Test", "ID": 3 }, { "protocol": 17, "port": 4444, "description": "Reserved Seating Test", "ID": 4 }, { "protocol": 6, "port": 8080, "description": "Reserved Seating Test 8080", "ID": 5 }, { "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP", "ID": 6 } ] }
Obtenir une règle de places réservées unique
Cette API vous permet d'obtenir une règle de places réservées unique.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules(reservedSeatingRuleID)
Méthode
GET
Exemple de demande
http://127.0.0.1:8981/odata/api/reservedSeatingRules(4)
Exemple de réponse
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#reservedSeatingRules(ID,protocol,port,description)/$entity", "protocol": 17, "port": 4444, "description": "Reserved Seating Test", "ID": 4 }
Création de règles de places réservées
Cette API vous permet de créer une règle de places réservées.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules
Méthode
POST
Charge utile
{ "protocol": <protocol value>, "port": <port value>,, "description": "<description details>" }
Exemple de demande
http://127.0.0.1:8981/odata/api/reservedSeatingRules
Exemple de charge utile
{ "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP" }
Exemple de réponse
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#reservedSeatingRules(ID,protocol,port,description)/$entity", "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP", "ID": 6 }
Mise à jour des règles de places réservées
Cette API vous permet de mettre à jour une règle de places réservées unique. Elle ne prend pas en charge les modifications en bloc.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules(reservedSeatingRuleID)
Méthode
PATCH
Charge utile
{ "protocol": <protocol value>, "port": <port value>,, "description": "<description details>" }
Exemple de demande
http://127.0.0.1:8981/odata/api/reservedSeatingRules(5)
Exemple de charge utile
{ "protocol": 17, "port": 8080, "description": "Reserved Seating Test 8080 UDP Update" }
Exemple de réponse
Cette API ne renvoie aucune réponse.
Suppression des règles de places réservées
Cette API vous permet de supprimer une règle de places réservées unique.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules(reservedSeatingRuleID)
Méthode
DELETE
Exemple de demande
La demande suivante illustre l'action de suppression pour l'ID de règle de places réservées 5.
http://127.0.0.1:8981/odata/api/reservedSeatingRules(5)
Exemple de réponse
Cette API ne renvoie aucune réponse.
Suppression en bloc des règles de places réservées
Le code suivant est une section de métadonnées de référence pour supprimer des règles de places réservées en bloc.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/reservedSeatingRules/com.ca.nfa.odata.deleteReservedSeatingRules
Méthode
POST
Charge utile
"RuleIds":[<List of rule_ids separated by a comma>]
Exemple de demande
La demande suivante illustre l'action de suppression en bloc des règle de places réservées.
http://127.0.0.1:8981/odata/api/reservedSeatingRules/com.ca.nfa.odata.deleteReservedSeatingRules
Exemple de charge utile
{ "RuleIds": [4,5] }
Exemple de réponse
{ "@odata.context": "$metadata#Collection(com.ca.nfa.odata.reservedSeatingRules)", "value": [ { "ID": 4, "protocol": 17, "port": 4444, "description": "Reserved Seating Test" }, { "ID": 5, "protocol": 6, "port": 8080, "description": "Reserved Seating Test 8080" } ] }
Contrôles de validation
Les validations de données suivantes doivent être prises en compte lors de la saisie des valeurs.
  • La combinaison du protocole et du port doit être unique.
  • Les valeurs du protocole doivent être 6 pour TCP et 17 ou UDP.
  • Les valeurs des ports doivent être comprises entre 0 et 65535.
  • La longueur de la description doit être inférieure à 100 caractères.