Documentation
Table of Contents
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.
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 | string/array | Renvoie uniquement les actions avec les identifiants donnés. |
| groupids | string/array | Renvoie uniquement les actions qui utilisent les groupes d'hôtes donnés dans les conditions d'action. |
| hostids | string/array | Renvoie uniquement les actions qui utilisent les hôtes donnés dans les conditions d'action. |
| triggerids | string/array | Renvoie uniquement les actions qui utilisent les déclencheurs donnés dans les conditions d'action. |
| mediatypeids | string/array | Renvoie uniquement les actions qui utilisent les types de média donnés pour envoyer des messages. |
| usrgrpids | string/array | Renvoie uniquement les actions configurées pour envoyer des messages aux groupes d'utilisateurs donnés. |
| userids | string/array | Renvoie uniquement les actions configurées pour envoyer des messages à des utilisateurs donnés. |
| scriptids | string/array | Renvoie uniquement les actions configurées pour exécuter les scripts donnés. |
| selectFilter | query | Renvoie le filtre d'action dans la propriété filter. |
| selectOperations | query | Renvoie les opérations d'action dans la propriété operations. |
| selectRecoveryOperations | query | Renvoie les opérations de récupération d'action dans la propriété recoveryOperations. |
| selectAcknowledgeOperations | query | Renvoie les opérations d'acquittement d'action dans la propriété acknowledgeOperations. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : actionid, name et status. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les commentaires de référence. |
| editable | boolean | |
| 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
countOutputa été utilisé.
Exemples
Récupération des actions de découverte
Récupérez toutes les actions de découverte configurées avec les conditions d'action et les opérations. Le filtre utilise le type d'évaluation "et". La propriété "formula" est donc vide et "eval_formula" est généré automatiquement.
Requête :
{
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectRecoveryOperations": "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",
"def_shortdata": "",
"def_longdata": "",
"r_shortdata": "",
"r_longdata": "",
"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": [
{
"operationid": "1",
"templateid": "10001"
}
]
},
{
"operationid": "2",
"actionid": "2",
"operationtype": "4",
"esc_period": "0s",
"esc_step_from": "1",
"esc_step_to": "1",
"evaltype": "0",
"opconditions": [],
"opgroup": [
{
"operationid": "2",
"groupid": "2"
}
]
}
],
"recoveryOperations": [
{
"operationid": "585",
"actionid": "2",
"operationtype": "11",
"evaltype": "0",
"opconditions": [],
"opmessage": {
"operationid": "585",
"default_msg": "1",
"subject": "{TRIGGER.STATUS}: {TRIGGER.NAME}",
"message": "Trigger: {TRIGGER.NAME}\r\nTrigger status: {TRIGGER.STATUS}\r\nTrigger severity: {TRIGGER.SEVERITY}\r\nTrigger URL: {TRIGGER.URL}\r\n\r\nItem values:\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\nOriginal event ID: {EVENT.ID}",
"mediatypeid": "0"
}
}
],
"acknowledgeOperations": [
{
"operationid": "585",
"operationtype": "12",
"evaltype": "0",
"opmessage": {
"default_msg": "1",
"subject": "Acknowledged: {TRIGGER.NAME}",
"message": "{USER.FULLNAME} acknowledged problem at {ACK.DATE} {ACK.TIME} with the following message:\r\n{ACK.MESSAGE}\r\n\r\nCurrent problem status is {EVENT.STATUS}",
"mediatypeid": "0"
}
},
{
"operationid": "586",
"operationtype": "0",
"evaltype": "0",
"opmessage": {
"default_msg": "1",
"subject": "Acknowledged: {TRIGGER.NAME}",
"message": "{USER.FULLNAME} acknowledged problem at {ACK.DATE} {ACK.TIME} with the following message:\r\n{ACK.MESSAGE}\r\n\r\nCurrent problem status is {EVENT.STATUS}",
"mediatypeid": "0"
},
"opmessage_grp": [
{
"usrgrpid": "7"
}
],
"opmessage_usr": []
},
{
"operationid": "587",
"operationtype": "1",
"evaltype": "0",
"opcommand": {
"type": "0",
"scriptid": "0",
"execute_on": "0",
"port": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"command": "notify.sh"
},
"opcommand_hst": [
{
"hostid": "0"
}
],
"opcommand_grp": []
}
]
}
],
"id": 1
}Voir également
Source
CAction::get() dans frontends/php/include/classes/api/services/CAction.php.