Page History

Introduction

L'API fournie par les écouteurs est de type REST ; elle fonctionne donc par l'intermédiaire des différentes actions du protocole HTTP:

• GET : Obtenir des informations sur un objet, ou la liste des objets
• PUT : Créer ou modifier un objet
• POST : Modifier un objet
• DELETE : Supprimer un objet

L'identifiant des objets est fournie dans l'URL, et les données supplémentaires, quand cela est  nécessaire, sont fournies dans le corps de la requête HTTP sous la forme d'un objet JSON.

Cette page décrit les différentes actions réalisables ainsi que le format des données.

Description des actions

Les exemples utilisent la commande curl, disponible dans la plupart des distributions Linux ; cependant la requête HTTP peut être réalisée avec l'outil de votre choix.

Description générale d'une requête

Une requête est composée de plusieurs éléments :

• Action HTTP : l'action que l'écouteur doit effectuer ; les actions disponibles sont décrites en détail dans les sections suivantes
• Adresse et port d'écoute du LIstener : l'adresse est celle du Synchronizer, le port du listener REST fourni avec Shinken Entreprise est le 7761
• Nom du listener : il s'agit du nom du listener tel que défini dans la propriété listener_name du fichier de définition du listener ; le listener fourni avec Shinken Entreprise est listener-rest
• Version du protocole : dans cette version de Shinken Entreprise, il s'agit de la v1 ; si le protocole évolue dans de futures versions, le numéro de version évoluera également, ce qui permettra au listener de conserver la compatibilité avec la version actuelle
• Type d'objet Shinken : le type d'objet Shinken traité par la requête. Actuellement, seuls les hôtes sont gérés.
• Header HTTP : La liste des en-têtes HTTP ; dans le cas du listener ; nous spécifions que nous envoyons du contenu JSON
• Données de l'objet : Les données décrivant l'objet à importer respectent le format JSON. Il s'agit d'un dictionnaire décrivant toutes les propriétés de l'objet ; Elles sont définies de la même manière que dans les fichiers CFG et décrites sur cette page.

PUT

Cette action permet d'envoyer à l'écouteur un nouvel objet ou de modifier un objet existant

• Lors de la création d'un nouvel objet, le listener renvoie l'identifiant de l'objet créé sous la forme "core-hosts-<ID>" . Cet identifiant devra être utilisé lors d'autres opérations manipulant l'objet :
  
  

$  curl -u 'root:root' -X PUT http://localhost:7761/shinken/listener-rest/v1/hosts -d '{ "host_name": "hote-example", "use":"linux", "_SSH_USER":"root", "_SSH_KEY_PASSPHRASE":"root" }'
"core-hosts-22b48e7408a549f6895badada2fd3690"

• Pour modifier un objet existant, on indique son identifiant dans l'URL :
  
  

$  curl -u 'root:root' -X PUT http://localhost:7761/shinken/listener-rest/v1/hosts/core-hosts-22b48e7408a549f6895badada2fd3690 -d '{ "address": "192.168.1.42" }'
done

GET

Cette action a deux significations possibles :

• Lorsqu'on fournit un identifiant d'hôte dans l'URL, l'objet JSON décrivant cet objet est renvoyé

$ curl -u 'root:root' http://localhost:7761/shinken/listener-rest/v1/hosts/core-hosts-22b48e7408a549f6895badada2fd3690 | python -mjson.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   381  100   381    0     0  72668      0 --:--:-- --:--:-- --:--:-- 76200
{
    "_SE_UUID": "core-hosts-22b48e7408a549f6895badada2fd3690",
    "_SSH_KEY_PASSPHRASE": "root",
    "_SSH_USER": "root",
    "_SYNC_KEYS": "core-hosts-22b48e7408a549f6895badada2fd3690,hote-example",
    "_id": "22b48e7408a549f6895badada2fd3690",
    "host_name": "hote-example",
    "imported_from": "listener-rest envoy\u00e9 depuis l'adresse 127.0.0.1",
    "update_date": 1527839180.6257291,
    "use": "linux"
}

• Lorsqu'on ne fournit pas d'identifiant, la liste des objets créés avec ce listener est renvoyée

$ curl -u 'root:root' http://localhost:7761/shinken/listener-rest/v1/hosts/ | python -m json.tool
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   785  100   785    0     0   104k      0 --:--:-- --:--:-- --:--:--  109k
[
    {
        "_SE_UUID": "core-hosts-22b48e7408a549f6895badada2fd3690",
        "_SSH_KEY_PASSPHRASE": "root",
        "_SSH_USER": "root",
        "_SYNC_KEYS": "core-hosts-22b48e7408a549f6895badada2fd3690,hote-example",
        "_id": "22b48e7408a549f6895badada2fd3690",
        "host_name": "hote-example",
        "imported_from": "listener-rest envoy\u00e9 depuis l'adresse 127.0.0.1",
        "update_date": 1527839180.6257291,
        "use": "linux"
    },
    {
        "_SE_UUID": "core-hosts-bafe4fae3fc447b992daa3f10ee260f2",
        "_SYNC_KEYS": "core-hosts-bafe4fae3fc447b992daa3f10ee260f2,hote-example-2",
        "_id": "bafe4fae3fc447b992daa3f10ee260f2",
        "address": "192.168.0.42",
        "host_name": "hote-example-2",
        "imported_from": "listener-rest envoy\u00e9 depuis l'adresse 127.0.0.1",
        "update_date": 1527839954.469449,
        "use": "shinken-full"
    }
]

DELETE

Cette action permet de supprimer un élément des objets importés par le listener. Il n'est pas possible de supprimer les éléments ne provenant pas de la même source, pour des raisons de sécurité.

$ curl -u 'root:root' -X DELETE http://localhost:7761/shinken/listener-rest/v1/hosts/core-hosts-22b48e7408a549f6895badada2fd3690
done