API pbehavior

L'API pbehavior permet de consulter, créer et supprimer des comportements périodiques.

Pour plus d'informations sur ce qu'est un comportement périodique, consulter la documentation du moteur pbehavior.

Création d'un comportement périodique

Crée un nouveau comportement périodique à partir du corps de la requête.

URL : /api/v2/pbehavior

Méthode : POST

Authentification requise : Oui

Permissions requises : Aucune

Exemple de corps de requête :

{
    "author": "root",
    "name": "Pbehavior test 1",
    "tstart": 1567439123,
    "tstop": 1569599100,
    "filter": {
        "$or": [{
            "impact": {
                "$in": ["pbehavior_test_1"]
            }
        }, {
            "$and": [{
                "type": "component"
            }, {
                "name": "pbehavior_test_1"
            }]
        }]
    },
    "type_": "Hors plage horaire de surveillance",
    "reason": "Autre",
    "rrule": null,
    "comments": [],
    "exdate": []
}

Exemple de requête curl pour utilisateur root avec mot de passe root qui veut ajouter le JSON ci-dessus :

curl -X POST -u root:root -H "Content-Type: application/json" -d '{
    "author": "root",
    "name": "Pbehavior test 1",
    "tstart": 1567439123,
    "tstop": 1569599100,
    "filter": {
        "$or": [{
            "impact": {
                "$in": ["pbehavior_test_1"]
            }
        }, {
            "$and": [{
                "type": "component"
            }, {
                "name": "pbehavior_test_1"
            }]
        }]
    },
    "type_": "Hors plage horaire de surveillance",
    "reason": "Autre",
    "rrule": null,
    "comments": [],
    "exdate": []
}' 'http://<Canopsis_URL>/api/v2/pbehavior'

Réponse en cas de réussite

Condition : le comportement périodique est créé

Code : 200 OK

Exemple du corps de la réponse :

{
    "e89d0a8f-8ccd-4357-83e9-ea3f8a53ebb2"
}

Cas particulier : Permettre la création d'un comportement périodique avec un _id déjà existant

Note

Disponible depuis Canopsis 3.38.0.

Lorsque les comportements périodiques sont pilotés par l'API (via un ordonnanceur par exemple), il est parfois nécessaire de devoir « écraser » un comportement périodique déjà existant mais qui serait expiré.

Un paramètre complémentaire peut être passé à l'API dans ce cas : replace_expired.

URL : /api/v2/pbehavior?replace_expired=1

Exemple de corps de requête :

{
    "_id": "pbh1",
    "author": "root",
    "name": "Pbehavior test 1",
    "tstart": 1567439123,
    "tstop": 1569599100,
    "filter": {
        "$or": [{
            "impact": {
                "$in": ["pbehavior_test_1"]
            }
        }, {
            "$and": [{
                "type": "component"
            }, {
                "name": "pbehavior_test_1"
            }]
        }]
    },
    "type_": "Hors plage horaire de surveillance",
    "reason": "Autre",
    "rrule": null,
    "comments": [],
    "exdate": []
}

Dans ce cas, si le comportement périodique dont l'_id vaut "pbh1" est expiré, alors

  • ce comportement périodique est renommé avec le format : EXP{current_timestamp_in_milliseconds}-{_id}
  • un nouveau comportement périodique avec les caractéristiques données en paramètre est créé

Modification de comportement périodique

Modifie un comportement périodique à partir du corps de la requête.

Les champs eids et comments des comportements périodiques ne sont pas modifiables avec cette route. Ils ne sont pas pris en compte s'ils sont présents dans le corps de la requête.

URL : /api/v2/pbehavior/<pbehavior_id>

Méthode : PUT

Authentification requise : Oui

Permissions requises : Aucune

Exemple de corps de requête :

{
    "author": "root",
    "name": "Pbehavior test 1",
    "tstart": 1567439123,
    "tstop": 1569599100,
    "filter": {
        "$or": [{
            "impact": {
                "$in": ["pbehavior_test_1"]
            }
        }, {
            "$and": [{
                "type": "component"
            }, {
                "name": "pbehavior_test_1"
            }]
        }]
    },
    "type_": "Hors plage horaire de surveillance",
    "reason": "Autre",
    "rrule": "FREQ=WEEKLY;BYDAY=FR,TH",
    "comments": [],
    "exdate": []
}

Exemple de requête curl pour utilisateur root avec mot de passe root qui veut envoyer le JSON ci-dessus pour modifier le comportement périodique dont l'_id vaut 6dacc239-59e8-4ba9-b1d0-e9c08ab8eacd :

curl -X PUT -u root:root -H "Content-Type: application/json" -d '{
    "author": "root",
    "name": "Pbehavior test 1",
    "tstart": 1567439123,
    "tstop": 1569599100,
    "filter": {
        "$or": [{
            "impact": {
                "$in": ["pbehavior_test_1"]
            }
        }, {
            "$and": [{
                "type": "component"
            }, {
                "name": "pbehavior_test_1"
            }]
        }]
    },
    "type_": "Hors plage horaire de surveillance",
    "reason": "Autre",
    "rrule": "FREQ=WEEKLY;BYDAY=FR,TH",
    "comments": [],
    "exdate": []
}' 'http://<Canopsis_URL>/api/v2/pbehavior/e89d0a8f-8ccd-4357-83e9-ea3f8a53ebb2'

Réponse en cas de réussite

Condition : le comportement périodique est modifié

Code : 200 OK

Exemple du corps de la réponse :

{
    "name": "PBehavior de test",
    "author": "root",
    "reason": "Autre",
    "filter": "{\"$or\": [{\"impact\": {\"$in\": [\"pbehavior_test_1\"]}}, {\"$and\": [{\"type\": \"pbehavior_test_1\"}, {\"name\": \"pbehavior_test_1\"}]}]}",
    "type_": "Hors plage horaire de surveillance",
    "exdate": [],
    "tstart": 1567429156,
    "tstop": 1567601940
}

Suppression de comportement périodique

Supprime un comportement périodique en fonction de son id.

URL : /api/v2/pbehavior/<pbehavior_id>

Méthode : DELETE

Authentification requise : Oui

Permissions requises : Aucune

Exemple de requête curl pour utilisateur root avec mot de passe root qui veut supprimer le comportement périodique avec l'id 6dacc239-59e8-4ba9-b1d0-e9c08ab8eacd :

curl -X DELETE -u root:root 'http://<Canopsis_URL>/api/v2/pbehavior/e89d0a8f-8ccd-4357-83e9-ea3f8a53ebb2'

Réponse en cas de réussite

Condition : La suppression du comportement périodique a réussi.

Code : 200 OK

Exemple du corps de la réponse :

{
    "deletedCount": 1,
    "acknowledged": true
}

Récupération des comportements périodiques

Récupère un ou plusieurs comportements périodiques appliqués sur une entité, via l'eid (pour entity id).

Récupération d'un comportement périodique par eid

URL : /api/v2/pbehavior_byeid/<entity_id>

Méthode : GET

Authentification requise : Oui

Permissions requises : Aucune

Exemple de requête curl pour utilisateur root avec mot de passe root pour récupérer les comportements périodiques s'appliquant à l'entité dont l'_id est disk2/pbehavior_test_1 :

curl -X GET -u root:root 'http://<Canopsis_URL>/api/v2/pbehavior_byeid/disk2/pbehavior_test_1'
Réponse en cas de réussite

Condition : Au moins un comportement périodique appliqué à une entité correspondant à l'id est trouvé.

Code : 200 OK

Exemple du corps de la réponse :

[{
    "name": "Pbehavior test 1",
    "author": "root",
    "eids": ["pbehavior_test_1", "disk2/pbehavior_test_1"],
    "reason": "Autre",
    "filter": "{\"$or\": [{\"impact\": {\"$in\": [\"pbehavior_test_1\"]}}, {\"$and\": [{\"type\": \"component\"}, {\"name\": \"pbehavior_test_1\"}]}]}",
    "type_": "Hors plage horaire de surveillance",
    "rrule": "FREQ=WEEKLY;BYDAY=FR,TH",
    "tstart": 1567439123,
    "tstop": 1569599100,
    "_id": "4c441d4e-9cc8-4f84-be73-9a4e97ba5e74",
    "isActive": true,
    "exdate": [],
    "is_currently_active": false
}]

Récupération de tous les comportements périodiques en base de données

Récupère tous les comportements périodiques stockés en base

URL : /pbehavior/read

Méthode : GET

Authentification requise : Oui

Permissions requises : Aucune

Supporte la pagination : Oui

Exemple de requête curl pour utilisateur root avec mot de passe root pour récupérer tous les comportements périodiques :

curl -X GET -u root:root 'http://<Canopsis_URL>/pbehavior/read'
Réponse en cas de réussite

Condition : aucune.

Code : 200 OK

Exemple du corps de la réponse :

{
    "total": 1,
    "data": [{
        "count": 1,
        "total_count": 1,
        "data": [{
            "connector": "canopsis",
            "name": "Pbehavior test 1",
            "author": "root",
            "enabled": true,
            "reason": "Autre",
            "comments": [],
            "filter": "{\"$or\": [{\"impact\": {\"$in\": [\"pbehavior_test_1\"]}}, {\"$and\": [{\"type\": \"component\"}, {\"name\": \"pbehavior_test_1\"}]}]}",
            "type_": "Hors plage horaire de surveillance",
            "connector_name": "canopsis",
            "eids": [],
            "tstart": 1567439123,
            "timezone": "Europe/Paris",
            "tstop": 1569599100,
            "_id": "aaa9d5c3-b245-481f-b23a-844893cb3cfe",
            "rrule": "FREQ=WEEKLY;BYDAY=FR,TH",
            "exdate": [],
            "is_currently_active": true
        }]
    }],
    "success": true
}

Note

Disponible depuis Canopsis 3.40.0.

Le paramètre current_active_pbh permet de récupérer uniquement les comportements périodiques qui sont actifs au moment de la requête.

Ce paramètre est de type booléen.

URL : /api/v2/pbehavior?current_active_pbh=true


Dernière mise à jour: 2020-05-04