Options de requête personnalisée

Les options de requête personnalisée fournissent des informations supplémentaires au service OData de CA NFA, informations qu'elles incluent dans la chaîne de requête d'URL. Les options de requête personnalisée ne doivent pas commencer par un caractère $ ou @.
nfa1000
Les options de requête personnalisée fournissent des informations supplémentaires au service OData de CA NFA, informations qu'elles incluent dans la chaîne de requête d'URL. Les options de requête personnalisée ne doivent pas commencer par un caractère $ ou @.
Les paramètres de requête personnalisée ci-dessous sont pris en charge :
Paramètre de requête personnalisée
Description
startTime
Horodatage UNIX qui indique l'heure de début des données de mesure NFA. Si vous ne spécifiez aucune heure de début, elle est définie sur l'heure de fin spécifiée moins une heure.
endTime
Horodatage UNIX qui indique l'heure de fin des données de mesure NFA.Si vous ne spécifiez aucune heure de fin, elle est définie sur l'heure de début spécifiée plus une heure.
resolution
Spécifie les données cibles. Les valeurs valides sont
min1
ou
min15
, pour 1 minute ou 15 minutes respectivement.
queryTimeOut
Remplace le limiteur par défaut du système (defaultQueryTimeout) pour exécution de requêtes présent dans les limiteurs OData de CA NFA.Les valeurs sont exprimées en secondes.
timeout
Remplace le limiteur par défaut du système (requestTimeout ) pour requête HTTP présent dans les limiteurs OData de CA NFA.Les valeurs sont exprimées en secondes.
Noms de protocole (A partir de NFA 22.2.2)
Inclut des noms de protocole dans la réponse pour les entités avec la propriété de protocole.
Nous vous recommandons de saisir les paramètres startTime et endTime. Cependant, si vous choisissez de ne pas les spécifier, l'horodatage UNIX correspond, par défaut, à la dernière heure à laquelle la requête a été trouvée.
URI de la demande
http://<
nfa odata host
>:<
nfa odata port
>/odata/api/<
Entity Type
>(<
PropertyRef Name value
>)/<
NavigationProperty
>?<
Custom Query parameter
>=<Value of
Custom Query parameter
>
Méthode
GET
Paramètres
Paramètres
Description
Entity Type
Indique le type d'entité.
Pour plus d'informations sur la liste de valeurs EntityType valides, consultez l'article Metadata (Métadonnées).
PropertyRef Name value
Indique la valeur du nom de référence de la propriété.
Pour plus d'informations sur la liste de valeurs PropertyRef Name, consultez l'article Metadata (Métadonnées).
Custom Query parameter
Indique le type de paramètre de requête personnalisée. Les paramètres de requête personnalisée ci-dessous sont pris en charge :
  • startTime
  • endTime
  • resolution
  • queryTimeOut
  • timeout
Exemples
Liste des exemples d'options de requête personnalisée :
Exemple pour startTime
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(3)/hosts?startTime=1541894400
Exemple de réponse
{
"@odata.context": "$metadata#hosts",
"value": [
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541894400,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541894400,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541894400,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541894400,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541895300,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541895300,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541895300,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541895300,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541896200,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541896200,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
}
],
"@odata.nextLink": "http://127.0.0.1:8981/odata/api/interfaces(3)/hosts?startTime=1541894400&$skiptoken=10"
}
Exemple pour endTime
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(3)/hosts?endTime=1541808000
Exemple de réponse
{
"@odata.context": "$metadata#hosts",
"value": [
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541804400,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541804400,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541804400,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541804400,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541805300,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541805300,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541805300,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541805300,
"protocol": 393239,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541806200,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
},
{
"router": "127.0.0.1",
"interface": 2,
"timestamp": 1541806200,
"protocol": 0,
"host": "127.0.0.1",
"inoctets": 1650000,
"outoctets": 1650000
}
],
"@odata.nextLink": "http://127.0.0.1:8981/odata/api/interfaces(3)/hosts?endTime=1541808000&$skiptoken=10"
}
Exemple pour startTime et endTime
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(10)/hosts?startTime=1541894400&endTime=1541808000
Exemple sans startTime et endTime
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(10)/hosts?resolution=min15
Exemple pour resolution
Exemple de demande
http://127.0.0.1:8981/odata/api/routers(1500001)/deviceName?resolution=min2
Exemple de réponse
{
"@odata.context": "../$metadata#routers/deviceName",
"value": "127.0.0.1"
}
Exemple pour queryTimeOut
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(291)/hosts?queryTimeOut=
Exemple pour timeout
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(291)/hosts?timeout
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(291)/hosts?timeout
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 nom de protocole (A partir de NFA 22.2.2)
Exemple de demande :
http://127.0.0.1:8981/odata/api/interfaces%28291%29/hosts?protocolNames=true