Objectifs

Méthode POST de type READ qui permet de récupérer des données de supervision d'un check et éventuellement de son père comme sur l'Interface de Visualisation.

Paramètres

Le paramètre ID reçu dans l'URL identifie l'élément à rechercher.

Sa nature (nom ou UUID) est définie à l'aide du paramètre is_name  (paramètre POST, détaillé ci-dessous). 

Certains caractères sont interdits dans les URL, ils doivent être échappés (URL encodées) pour pouvoir être utilisés

caractère interdit:/?#[]@!$&'()*+,;=%(espace)
remplacement%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D%25%20  ou  +

Pour plus d'information, vous pouvez consulter : https://developer.mozilla.org/fr/docs/Glossary/percent-encoding et rfc3986

Exemple: pour utiliser le nom ch@nged_name  il faudra utiliser l'url  http://broker-module-livedata:50100/api/v2/check/ch%40nged_name

Les 2 paramètres suivants sont également disponibles :

NomTypeDéfautCommentaire

is_name 

Booléen true Paramètre dans le corps de la requête POST :
  • true, ID est considéré comme un nom d'hôte pour la récupération de l'hôte
  • false, ID est considéré comme un UUID pour la récupération de l'hôte

ID

text

Paramètre dans l'URL de la requête POST :

Si is_name est sur false : ID est composé de l'uuid de l'hôte suivi de l'uuid du check associé, séparés par un -.

Exemple :

693693aa225011efbf01080027db8bdb-f77a15d8225011efa15d080027db8bdb

Réponse

Codes de retour

Codes de retourExplications
200

OK

400

Paramètre invalide

401

Accès nécessite une authentification ou un Token valide.

403

Authentification de l'utilisateur OK , mais droits non suffisants.

404

L'hôte demandé n'existe pas

405

L’élément correspondant à l'ID n'est pas un hôte

500

L'appel est valide, mais un problème d'exécution est survenu.

Retour du code 200

Les propriétés retournées doivent être choisies avec l'option output_field

Mais les propriétés suivantes seront au minimum automatiquement retournées :

  • type,
  • father_uuid,
  • father_name,
  • check_uuid,
  • check_name.


Voir la page  V2 - Les API du broker-module-livedata - les propriétés présentes dans le retour 200, pour la description complète de toutes les propriétés pouvant être renvoyée.

curl -s -S -H 'x-api-token: XYZ' \
http://broker-module-livedata:50100/api/v2/check/CPU%20Stats
{
  "request_statistics": {
    "nb_elements_total": 9,
    "nb_checks_total": 4,
    "nb_elements_filtered": 2,
    "nb_checks_filtered": 2
  },
  "elements_found": [
    {
      "check_name": "CPU Stats",
      "check_uuid": "2c6dcf1aba1611ebaa7d0800277faebe-c296d75e5ad911e58cc5080027f08538",
      "father_name": "Bordeaux",
      "father_uuid": "2c6dcf1aba1611ebaa7d0800277faebe",
      "type": "check_host"
    },
    {
      "check_name": "CPU Stats",
      "check_uuid": "76f45d80ba1e11eba2670800277faebe-c296d75e5ad911e58cc5080027f08538",
      "father_name": "Nantes",
      "father_uuid": "76f45d80ba1e11eba2670800277faebe",
      "type": "check_host"
    }
  ]
}

Retour du code 400

Paramètre GET absent ( ID )

Le paramètre attendu est un nom
curl -s -S -H "x-api-token: XYZ" \
http://broker-module-livedata:50100/api/v2/check

ERROR 400: mandatory parameter [ name ] is missing

Le paramètre attendu est un UUID
curl -s -S -H "x-api-token: XYZ" \
-d "is_name=false" \
http://broker-module-livedata:50100/api/v2/check

ERROR 400: mandatory parameter [ uuid ] is missing

Paramètres POST incorrects

Paramètre inconnu
curl -s -S -H "x-api-token: XYZ" \
-d "parametre_inconnu=is_status_:true" \
http://broker-module-livedata:50100/api/v2/check/ID

ERROR 400: POST parameter [ parametre_inconnu ] is unknown

Paramètre désactivé sur cette route
curl -s -S -H "x-api-token: XYZ" \
-d "output_format=checks_attached_to_father" \
http://broker-module-livedata:50100/api/v2/check/ID

ERROR 400: POST parameter [ output_format ] is not available for this route

Messages d'erreurs lors du paramétrage des propriétés présentes dans la sortie ( output_field )

Propriété de sortie inexistante
curl -s -S -H "x-api-token: XYZ" \
-d "output_field=is_status_" \
http://broker-module-livedata:50100/api/v2/check/ID

ERROR 400: output_field: invalid field name [ is_status_ ]

Messages d'erreurs liés au paramètre is_name

Valeur incorrecte
curl -s -S -H "x-api-token: XYZ" \
-d "is_name=cluster" \
http://broker-module-livedata:50100/api/v2/check/ID

ERROR 400: is_name: invalid value [cluster]