Navigation
La propriété de navigation est similaire à l'interface utilisateur de la console. Le nom de la propriété de navigation est parfois suivi d'un segment de chemin /$count et éventuellement d'un ensemble entre parenthèses d'options de développement telles que le filtrage, le tri, la sélection, la pagination ou le développement des entités associées.
nfa1000
La propriété de navigation est similaire à l'interface utilisateur de la console
Network Flow Analysis
. Le nom de la propriété de navigation est parfois suivi d'un segment de chemin /$count
et éventuellement d'un ensemble entre parenthèses d'options de développement telles que le filtrage, le tri, la sélection, la pagination ou le développement des entités associées.Listes d'options de navigation disponibles :
L'action que vous effectuez sur l'API NFA est la même que dans la console NFA. La liste des scénarios possibles pour la navigation dans la console NFA est illustrée dans le tableau suivant :
Pour cette interface (nom de l'entité) , afficher | Contenu de l'interface et < Value de l'interface sélectionnée dans la colonne précédente> |
Protocoles (protocols) | Hôtes |
Conversations | |
ToS (toss) | Protocoles |
Hôtes | |
Conversations | |
Hôtes (hosts) | Protocoles |
Conversations (conversations) | Protocoles |
asNums | asNextHop |
URL de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/<EntityType Name>(<PropertyRef Name>)/<EntityType Name>(<PropertyRef Name>)
Méthode
GET
Paramètres
Le tableau ci-dessous inclut les paramètres obligatoires.
Paramètres | Description |
EntityType Name | Indique le nom du type d'entité. Pour plus d'informations sur la liste de valeurs EntityType Name valides, consultez l'article Metadata (Métadonnées). |
PropertyRef Name | Indique le nom de référence de propriété de l'entité. Pour plus d'informations sur la liste de valeurs PropertyRef Name valides, consultez l'article Metadata (Métadonnées). |
Exemple de demande
Cet exemple illustre la navigation d'Interfaces à Hôtes.
http://127.0.0.1:8981/odata/api/interfaces(9)/hosts?&startTime=1526891820&endTime=1526896858&resolution=min15
Exemple de réponse
{ "@odata.context": "$metadata#hosts", "value": [ { "router": "127.0.0.1", "interface": 9, "timestamp": 1526892300, "protocol": 0, "host": "127.0.0.1", "inoctets": 1200000, "outoctets": 12000000 }, { "router": "127.0.0.1", "interface": 9, "timestamp": 1526892300, "protocol": 0, "host": "127.0.0.1", "inoctets": 12000000, "outoctets": 1200000 }, { "router": "127.0.0.1", "interface": 9, "timestamp": 1526892300, "protocol": 0, "host": "127.0.0.1", "inoctets": 795000, "outoctets": 7950000 }, { "router": "127.0.0.1", "interface": 9, "timestamp": 1526892300, "protocol": 0, "host": "127.0.0.1", "inoctets": 7950000, "outoctets": 795000 } ]}
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(79)/protocols(0)/hosts?$top=10&startTime=1536754500 &endTime=1537289100 &$filter=contains(host,'8.8.8.80')
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(79)/conversations?startTime=1536754500 &endTime=1537289100 &$filter=contains(DestHost,'80.80.80.80' )
Exemple de demande avec noms de protocole
http://127.0.0.1:8981/odata/api/interfaces(79)/conversations?startTime=1536754500 &endTime=1537289100 &$filter=contains(DestHost,'80.80.80.80' )&protocolNames=true
Si l'extraction et l'ajout de la propriété de nom de protocole nécessitent beaucoup de ressources et peuvent entraîner des temps de réponse longs, utilisez-la uniquement si nécessaire.
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(79)/conversations(SrcHost='127.0.0.1',DestHost='127.0.0.1')/protocols?$top=10&$count=true&startTime=1536754500 &endTime=1537289100
Exemple de demande avec noms de protocole
http://127.0.0.1:8981/odata/api/interfaces(79)/conversations(SrcHost='127.0.0.1',DestHost='127.0.0.1')/protocols?$top=10&$count=true&startTime=1536754500 &endTime=1537289100 &protocolNames=true
Si l'extraction et l'ajout de la propriété de nom de protocole nécessitent beaucoup de ressources et peuvent entraîner des temps de réponse longs, utilisez-la uniquement si nécessaire.
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(79)/asNums?&startTime=1536754500&endTime=1537289100&resolution=min15
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(79)/asNextHop?&startTime=1536754500&endTime=1537289100&resolution=min15&$filter=contains(nexthop,'172.168.0.1')
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(79)/asNums(0)/asNextHop?&startTime=1536754500&endTime=1537289100&resolution=min15