View Source

Objectifs

Méthode POST de type READ qui permet de récupérer des données de supervision, comme sur l'interface de visualisation,

Filtrées ( optionnel )
Triées
Rangées :
- En arbres ( hôtes/clusters => checks )
- Tous au même niveau

Contrairement à la route V2 - ( READ ) /api/v2/inventory, cette route permet de choisir les propriétés obtenues sur le résultat en sortie.

Toutefois, attention au volume de données que l'ajout de propriétés supplémentaires à récupérer peut engendrer.

Les paramètres

Cet appel utilise les 4 paramètres suivants :

filterX
sort
output_format
ouput_field

Voir la page V2 - Les paramètres des API du broker-module-livedata , pour leur description complète.

Réponse

Codes de retour

Codes de retour	Explications
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 suffisant.
500	L'appel est valide, mais un problème d'exécution est rencontré.

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 :

nb_element
type (si le paramètre output_format vaut elements_on_same_level )
father_uuid
father_name
par check :
- check_uuid
- check_name

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

Suivant le paramètre output_format ( checks_attached_to_father / elements_on_same_level )

( présentation du format de retour ci-dessus, mais se référer à l'exemple pour le format exact )

checks_attached_to_father:

request_statistics :
- ...
elements_found :
- clusters :
  - cluster1:
    - cluster_uuid : text
    - cluster_name : text
    - ...
    - checks :
      - check_uuid 1 : text, check_name1 : text, ...
      - check_uuid2 : text, check_name2 : text, ...
      - ...
  - ...
- hosts :
  - host 1:
    - father_uuid : text
    - father_name : text
    - ...
    - checks :
      - check_uuid1 : text, check_name1 : text, ...
      - check_uuid2 : text, check_name2 : text, ...
      - ...
  - ...

elements_on_same_level :

request_statistics :
- ...
elements_found:
- elem1:
  - type: cluster
  - father_name: text
  - father_uuid : text
  - ...
- elem2:
  - type: host
  - father_name: text
  - father_uuid : text
  - ...
- elem3:
  - type: check
  - check_uuid : text
  - check_name: text
  - father_name : text
  - father_uiid : text
  - ...
- elem4:
  - type: check
  - check_uuid : text
  - check_name: text
  - father_name : text
  - father_uiid : text
  - ...
- ...

curl -s -S -H 'x-api-token: XYZ' \
-d "output_format=checks_attached_to_father" \
-d "output_field=raw_perf_data~father_templates~status~context" \ 
-d "filter0=type:cluster^^host^^check_cluster" \
-d "filter1=type:check_host~father_name:Bordeaux~check_name:CPU stats" \
-d "filter2=type:check_host~father_name:bordeaux~check_name:Disks Stats" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

{
  "request_statistics": {
    "nb_elements_total": 9,
    "nb_hosts_total": 4,
    "nb_clusters_total": 1,
    "nb_checks_total": 4,
    "nb_elements_filtered": 8,
    "nb_hosts_filtered": 4,
    "nb_clusters_filtered": 1,
    "nb_checks_filtered": 3
  },
  "elements_found": {
    "clusters": [
      {
        "status": 0,
        "father_templates": [],
        "father_name": "datacenter bdx",
        "context": "NOTHING",
        "raw_perf_data": "",
        "father_uuid": "d6921ee8ba1511eba36c0800277faebe",
        "checks": [
          {
            "status": 0,
            "check_name": "System Uptime",
            "check_uuid": "d6921ee8ba1511eba36c0800277faebe-e6daad4cba1511eb95980800277faebe",
            "raw_perf_data": "",
            "context": "NOTHING"
          }
        ]
      }
    ],
    "hosts": [
      {
        "status": 0,
        "father_templates": [
          "linux"
        ],
        "father_name": "Bordeaux",
        "context": "NOTHING",
        "raw_perf_data": "rta=0.035000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0",
        "father_uuid": "2c6dcf1aba1611ebaa7d0800277faebe",
        "checks": [
          {
            "status": 0,
            "check_name": "CPU Stats",
            "check_uuid": "2c6dcf1aba1611ebaa7d0800277faebe-c296d75e5ad911e58cc5080027f08538",
            "raw_perf_data": "cpu_1_sys=5.10% cpu_1_usr=0.00% cpu_1_steal=0.00% cpu_1_soft=1.02% cpu_1_irq=0.00% cpu_1_nice=7.14% cpu_1_idle=86.73% cpu_1_iowait=0.00% cpu_1_guest=0.00% cpu_0_sys=4.21% cpu_0_usr=0.00% cpu_0_steal=0.00% cpu_0_soft=0.00% cpu_0_irq=0.00% cpu_0_nice=5.26% cpu_0_idle=90.53% cpu_0_iowait=0.00% cpu_0_guest=0.00% cpu_all_sys=4.69% cpu_all_usr=0.00% cpu_all_steal=0.00% cpu_all_soft=0.52% cpu_all_irq=0.00% cpu_all_nice=5.73% cpu_all_idle=89.06% cpu_all_iowait=0.00% cpu_all_guest=0.00%",
            "context": "NOTHING"
          },
          {
            "status": 0,
            "check_name": "Disks Stats",
            "check_uuid": "2c6dcf1aba1611ebaa7d0800277faebe-c29735965ad911e58cc5080027f08538",
            "raw_perf_data": "sda_r_by_sec=0r/s sda_w_by_sec=13w/s sda_rKB_by_sec=0rKB/s sda_wKB_by_sec=45wKB/s sda_util=0.28% dm-0_r_by_sec=0r/s dm-0_w_by_sec=12w/s dm-0_rKB_by_sec=0rKB/s dm-0_wKB_by_sec=45wKB/s dm-0_util=0.28% dm-1_r_by_sec=0r/s dm-1_w_by_sec=0w/s dm-1_rKB_by_sec=0rKB/s dm-1_wKB_by_sec=0wKB/s dm-1_util=0.00%",
            "context": "NOTHING"
          }
        ]
      },
      {
        "status": 0,
        "father_templates": [],
        "father_name": "Lyon",
        "context": "NOTHING",
        "raw_perf_data": "rta=0.013000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0",
        "father_uuid": "8db8b5f0ba1611eba60d0800277faebe",
        "checks": []
      },
      {
        "status": 2,
        "father_templates": [
          "shinken",
          "shinken-daemon",
          "shinken-synchronizer-db",
          "shinken-broker-db",
          "linux"
        ],
        "father_name": "Nantes",
        "context": "NOTHING",
        "raw_perf_data": " -6] ",
        "father_uuid": "76f45d80ba1e11eba2670800277faebe",
        "checks": []
      },
      {
        "status": 0,
        "father_templates": [],
        "father_name": "Rennes",
        "context": "NOTHING",
        "raw_perf_data": "rta=0.017000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0",
        "father_uuid": "e5460dc2ba1611eb81580800277faebe",
        "checks": []
      }
    ]
  }
}

curl -s -S -H 'x-api-token: XYZ' \
-d "output_format=elements_on_same_level" \
-d "output_field=raw_perf_data~father_templates~status~context" \ 
-d "filter0=type:cluster^^host^^check_cluster" \
-d "filter1=type:check_host~father_name:Bordeaux~check_name:CPU stats" \
-d "filter2=type:check_host~father_name:bordeaux~check_name:Disks Stats" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

{
  "request_statistics": {
    "nb_elements_total": 9,
    "nb_hosts_total": 4,
    "nb_clusters_total": 1,
    "nb_checks_total": 4,
    "nb_elements_filtered": 8,
    "nb_hosts_filtered": 4,
    "nb_clusters_filtered": 1,
    "nb_checks_filtered": 3
  },
  "elements_found": [
    {
      "status": 0,
      "father_templates": [
        "linux"
      ],
      "father_name": "Bordeaux",
      "raw_perf_data": "rta=0.011000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0",
      "context": "NOTHING",
      "father_uuid": "2c6dcf1aba1611ebaa7d0800277faebe",
      "type": "host"
    },
    {
      "status": 0,
      "father_name": "Bordeaux",
      "raw_perf_data": "cpu_1_sys=3.16% cpu_1_usr=1.05% cpu_1_steal=0.00% cpu_1_soft=0.00% cpu_1_irq=0.00% cpu_1_nice=5.26% cpu_1_idle=90.53% cpu_1_iowait=0.00% cpu_1_guest=0.00% cpu_0_sys=4.30% cpu_0_usr=0.00% cpu_0_steal=0.00% cpu_0_soft=1.08% cpu_0_irq=0.00% cpu_0_nice=6.45% cpu_0_idle=88.17% cpu_0_iowait=0.00% cpu_0_guest=0.00% cpu_all_sys=4.26% cpu_all_usr=0.00% cpu_all_steal=0.00% cpu_all_soft=0.53% cpu_all_irq=0.00% cpu_all_nice=6.38% cpu_all_idle=88.83% cpu_all_iowait=0.00% cpu_all_guest=0.00%",
      "context": "NOTHING",
      "check_name": "CPU Stats",
      "type": "check_host",
      "father_uuid": "2c6dcf1aba1611ebaa7d0800277faebe",
      "check_uuid": "2c6dcf1aba1611ebaa7d0800277faebe-c296d75e5ad911e58cc5080027f08538"
    },
    {
      "status": 0,
      "father_name": "Bordeaux",
      "raw_perf_data": "sda_r_by_sec=0r/s sda_w_by_sec=13w/s sda_rKB_by_sec=0rKB/s sda_wKB_by_sec=44wKB/s sda_util=0.26% dm-0_r_by_sec=0r/s dm-0_w_by_sec=12w/s dm-0_rKB_by_sec=0rKB/s dm-0_wKB_by_sec=44wKB/s dm-0_util=0.26% dm-1_r_by_sec=0r/s dm-1_w_by_sec=0w/s dm-1_rKB_by_sec=0rKB/s dm-1_wKB_by_sec=0wKB/s dm-1_util=0.00%",
      "context": "NOTHING",
      "check_name": "Disks Stats",
      "type": "check_host",
      "father_uuid": "2c6dcf1aba1611ebaa7d0800277faebe",
      "check_uuid": "2c6dcf1aba1611ebaa7d0800277faebe-c29735965ad911e58cc5080027f08538"
    },
    {
      "status": 0,
      "father_templates": [],
      "father_name": "datacenter bdx",
      "raw_perf_data": "",
      "context": "NOTHING",
      "father_uuid": "d6921ee8ba1511eba36c0800277faebe",
      "type": "cluster"
    },
    {
      "status": 0,
      "father_name": "datacenter bdx",
      "raw_perf_data": "",
      "context": "NOTHING",
      "check_name": "System Uptime",
      "type": "check_cluster",
      "father_uuid": "d6921ee8ba1511eba36c0800277faebe",
      "check_uuid": "d6921ee8ba1511eba36c0800277faebe-e6daad4cba1511eb95980800277faebe"
    },
    {
      "status": 0,
      "father_templates": [],
      "father_name": "Lyon",
      "raw_perf_data": "rta=0.013000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0",
      "context": "NOTHING",
      "father_uuid": "8db8b5f0ba1611eba60d0800277faebe",
      "type": "host"
    },
    {
      "status": 2,
      "father_templates": [
        "shinken",
        "shinken-daemon",
        "shinken-synchronizer-db",
        "shinken-broker-db",
        "linux"
      ],
      "father_name": "Nantes",
      "raw_perf_data": " -6] ",
      "context": "NOTHING",
      "father_uuid": "76f45d80ba1e11eba2670800277faebe",
      "type": "host"
    },
    {
      "status": 0,
      "father_templates": [],
      "father_name": "Rennes",
      "raw_perf_data": "rta=0.025000ms;1000.000000;3000.000000;0.000000 pl=0%;100;100;0",
      "context": "NOTHING",
      "father_uuid": "e5460dc2ba1611eb81580800277faebe",
      "type": "host"
    }
  ]
}

Retour du code 400

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/all-monitored-elements

ERROR 400: POST parameter [ parametre_inconnu ] is unknown

Messages d'erreurs des filtres

( voir la page V2 - Les paramètres des API du broker-module-livedata )

Filtre inexistant

curl -s -S -H "x-api-token: XYZ" \
-d "filter01=is_status_:true" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: filtering[0]: invalid field name [ is_status_ ]

Filtre incomplet

curl -s -S -H "x-api-token: XYZ" \
-d "filter0=next_check" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: filtering[0]: missing value for field [ next_check ]

Filtre incorrect

Valeur incorrecte pour ce type de filtre

curl -s -S -H "x-api-token: XYZ" \
-d "filter0=status:9" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: filtering[0]: field [ status ] => wrong value [u'9']

Opérateur incorrect

curl -s -S -H "x-api-token: XYZ" \
-d "filter0=next_check:avant" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: filtering[0]: field [ next_check ] unknown date constraint [ avant ]

Argument incorrect

curl -s -S -H "x-api-token: XYZ" \
-d "filter0=next_check:in-less-than|hier" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: filtering[0]: field [ next_check ] => [ in-less-than ] => invalid literal for int() with base 10: 'hier'

Messages d'erreurs liés aux paramètres de tri

( voir la page V2 - Les paramètres des API du broker-module-livedata )

Propriété inconnu

curl -s -S -H "x-api-token: XYZ" \
-d "sort=host" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: sort: invalid field name [ host ]

Ordre de tri incorrect

curl -s -S -H "x-api-token: XYZ" \
-d "sort=father_name:big" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: sort: invalid sort direction [ big ] for field [ father_name ]

Messages d'erreurs liés au paramètre de format du résultat

( voir la page V2 - Les paramètres des API du broker-module-livedata )

Valeur incorrecte

curl -s -S -H "x-api-token: XYZ" \
-d "output_format=vrai" \
http://broker-module-livedata:50100/api/v2/all-monitored-elements

ERROR 400: output_format: invalid value [ vrai ]

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

( voir la page V2 - Les paramètres des API du broker-module-livedata )

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/all-monitored-elements

ERROR 400: output_field: invalid field name [ is_status_ ]