action.get

Description

integer/array action.get(object parameters)

La méthode permet de récupérer des actions en fonction des paramètres donnés.

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
actionids ID/array Retourner uniquement les actions avec les ID donnés.
groupids ID/array Retourner uniquement les actions qui utilisent les groupes d'hôtes donnés dans les conditions d'action.
hostids ID/array Retourner uniquement les actions qui utilisent les hôtes donnés dans les conditions d'action.
triggerids ID/array Retourner uniquement les actions qui utilisent les déclencheurs donnés dans les conditions d'action.
mediatypeids ID/array Retourner uniquement les actions qui utilisent les types de média donnés pour envoyer des messages.
usrgrpids ID/array Retourner uniquement les actions configurées pour envoyer des messages aux groupes d'utilisateurs donnés.
userids ID/array Retourner uniquement les actions configurées pour envoyer des messages aux utilisateurs donnés.
scriptids ID/array Retourner uniquement les actions configurées pour exécuter les scripts donnés.
selectFilter query Retourner une propriété filter avec le filtre de condition d'action.
selectOperations query Retourner une propriété operations avec les opérations d'action.
selectRecoveryOperations query Retourner une propriété recovery_operations avec les opérations de récupération d'action.
selectUpdateOperations query Retourner une propriété update_operations avec les opérations de mise à jour d'action.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : actionid, name, status.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupérer les actions de déclencheur

Récupérez toutes les actions de déclencheur configurées ainsi que les conditions et opérations d'action.

Requête:

{
    "jsonrpc": "2.0",
    "method": "action.get",
    "params": {
        "output": "extend",
        "selectOperations": "extend",
        "selectRecoveryOperations": "extend",
        "selectUpdateOperations": "extend",
        "selectFilter": "extend",
        "filter": {
            "eventsource": 0
        }
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "actionid": "3",
            "name": "Signaler les problèmes aux administrateurs Zabbix",
            "eventsource": "0",
            "status": "1",
            "esc_period": "1h",
            "pause_suppressed": "1",
            "filter": {
                "evaltype": "0",
                "formula": "",
                "conditions": [],
                "eval_formula": ""
            },
            "operations": [
                {
                    "operationid": "3",
                    "actionid": "3",
                    "operationtype": "0",
                    "esc_period": "0",
                    "esc_step_from": "1",
                    "esc_step_to": "1",
                    "evaltype": "0",
                    "opconditions": [],
                    "opmessage": [
                        {
                            "default_msg": "1",
                            "subject": "",
                            "message": "",
                            "mediatypeid" => "0"
                        }
                    ],
                    "opmessage_grp": [
                        {
                            "usrgrpid": "7"
                        }
                    ]
                }
            ],
            "recovery_operations": [
                {
                    "operationid": "7",
                    "actionid": "3",
                    "operationtype": "11",
                    "evaltype": "0",
                    "opconditions": [],
                    "opmessage": {
                        "default_msg": "0",
                        "subject": "{TRIGGER.STATUS}: {TRIGGER.NAME}",
                        "message": "Déclencheur : {TRIGGER.NAME}\r\nÉtat du déclencheur : {TRIGGER.STATUS}\r\nSévérité du déclencheur : {TRIGGER.SEVERITY}\r\nURL du déclencheur : {TRIGGER.URL}\r\n\r\nValeurs des éléments :\r\n\r\n1. {ITEM.NAME1} ({HOST.NAME1}:{ITEM.KEY1}) : {ITEM.VALUE1}\r\n2. {ITEM.NAME2} ({HOST.NAME2}:{ITEM.KEY2}) : {ITEM.VALUE2}\r\n3. {ITEM.NAME3} ({HOST.NAME3}:{ITEM.KEY3}) : {ITEM.VALUE3}\r\n\r\nID de l'événement d'origine : {EVENT.ID}",
                        "mediatypeid": "0"
                    }
                }
            ],
            "update_operations": [
                {
                    "operationid": "31",
                    "operationtype": "12",
                    "evaltype": "0",
                    "opmessage": {
                        "default_msg": "1",
                        "subject": "",
                        "message": "",
                        "mediatypeid": "0"
                    }
                },
                {
                    "operationid": "32",
                    "operationtype": "0",
                    "evaltype": "0",
                    "opmessage": {
                        "default_msg": "0",
                        "subject": "Mis à jour : {TRIGGER.NAME}",
                        "message": "{USER.FULLNAME} a mis à jour le problème le {EVENT.UPDATE.DATE} à {EVENT.UPDATE.TIME} avec le message suivant :\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nL'état actuel du problème est {EVENT.STATUS}",
                        "mediatypeid": "1"
                    },
                    "opmessage_grp": [
                        {
                            "usrgrpid": "7"
                        }
                    ],
                    "opmessage_usr": []
                },
                {
                    "operationid": "33",
                    "operationtype": "1",
                    "evaltype": "0",
                    "opcommand": {
                        "scriptid": "3"
                    },
                    "opcommand_hst": [
                        {
                            "hostid": "10084"
                        }
                    ],
                    "opcommand_grp": []
                }
            ]
        }
    ],
    "id": 1
}

Récupération des actions de découverte

Récupérer toutes les actions de découverte configurées avec les conditions d'action et les opérations. Le filtre utilise le type d'évaluation "and", la propriété formula est donc vide et la propriété eval_formula est générée automatiquement.

Requête:

{
    "jsonrpc": "2.0",
    "method": "action.get",
    "params": {
        "output": "extend",
        "selectOperations": "extend",
        "selectFilter": "extend",
        "filter": {
            "eventsource": 1
        }
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "actionid": "2",
            "name": "Auto discovery. Linux servers.",
            "eventsource": "1",
            "status": "1",
            "esc_period": "0s",
            "pause_suppressed": "1",
            "filter": {
                "evaltype": "0",
                "formula": "",
                "conditions": [
                    {
                        "conditiontype": "10",
                        "operator": "0",
                        "value": "0",
                        "value2": "",
                        "formulaid": "B"
                    },
                    {
                        "conditiontype": "8",
                        "operator": "0",
                        "value": "9",
                        "value2": "",
                        "formulaid": "C"
                    },
                    {
                        "conditiontype": "12",
                        "operator": "2",
                        "value": "Linux",
                        "value2": "",
                        "formulaid": "A"
                    }
                ],
                "eval_formula": "A and B and C"
            },
            "operations": [
                {
                    "operationid": "1",
                    "actionid": "2",
                    "operationtype": "6",
                    "esc_period": "0s",
                    "esc_step_from": "1",
                    "esc_step_to": "1",
                    "evaltype": "0",
                    "opconditions": [],
                    "optemplate": [
                        {
                            "templateid": "10001"
                        }
                    ]
                },
                {
                    "operationid": "2",
                    "actionid": "2",
                    "operationtype": "4",
                    "esc_period": "0s",
                    "esc_step_from": "1",
                    "esc_step_to": "1",
                    "evaltype": "0",
                    "opconditions": [],
                    "opgroup": [
                        {
                            "groupid": "2"
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}

Voir également

Source

CAction::get() dans ui/include/classes/api/services/CAction.php.