Lister les FileMonitors¶
Nouveau dans la version 3.5.1: Ajout du service
- GET /v2/filemonitors¶
Renvoie une liste des FileMonitors reçus par le serveur respectant les filtres donnés en paramètres de requête, ou simplement le décompte si countOrder=true est passé en paramètre.
- Query Parameters
name (string) – Nom optionnel du FileMonitor à retourner
status (integer) – 0 pour tous les FileMonitors, 1 pour ceux actifs, -1 pour les inactifs.
countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.
Example request:
GET /v2/filemonitors HTTP/1.1 Host: example.com
- Status Codes
200 OK –
La requête s’est déroulée avec succès.
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "totalResults": 1, "totalSubResults": 1, "results": [ { "NAME": "string", "HOST": "string", "LAST_UPDATE": 1, "GLOBALOK": 1, "GLOBALERROR": 1, "TODAYOK": 1, "TODAYERROR": 1, "INTERVAL": 1, "STOPFILE": "string", "STATUSFILE": "string", "SUBDIRS": true, "DIRECTORIES": "string", "FILES": {} } ] }
La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.
Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.
Example response:
HTTP/1.1 400 Bad Request Content-Type: application/json { "errors": [ { "message": "Query parameter 'startTrans' : illegal value 'not_a_date'.", "errorCode": 4 }, { "message": "Query parameter 'status' : illegal value 'not_a_status'.", "errorCode": 4 } ] }