action.get

説明

integer/array action.get(object parameters)

このメソッドで、指定したパラメーターに応じたアクションを取得できます。

このメソッドは、あらゆるタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細については、ユーザーの役割を参照してください。

パラメータ

(object) は希望する出力を定義するパラメータ

このメソッドは以下のパラメータをサポートしています。

パラメータ	Type	説明
actionids	string/array	Return only actions with the given IDs.
groupids	string/array	Return only actions that use the given host groups in action conditions.
hostids	string/array	Return only actions that use the given hosts in action conditions.
triggerids	string/array	Return only actions that use the given triggers in action conditions.
mediatypeids	string/array	Return only actions that use the given media types to send messages.
usrgrpids	string/array	Return only actions that are configured to send messages to the given user groups.
userids	string/array	Return only actions that are configured to send messages to the given users.
scriptids	string/array	Return only actions that are configured to run the given scripts.
selectFilter	query	Return a filter property with the action condition filter.
selectOperations	query	Return an operations property with action operations.
selectRecoveryOperations	query	Return a recovery_operations property with action recovery operations.
selectUpdateOperations	query	Return an update_operations property with action update operations.
sortfield	string/array	Sort the result by the given properties. Possible values are: `actionid`, `name` and `status`.
countOutput	boolean	These parameters being common for all `get` methods are described in the reference commentary.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

戻り値

(integer/array) のどちらかを返します:

オブジェクトの配列。
もし countOutput パラメータが使用されている場合は、取得したオブジェクトの数。

例

トリガーアクションを取得する

設定されたすべてのトリガーアクションを、アクションの実行条件および実行内容と共に取得します。

リクエスト:

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

レスポンス:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "actionid": "3",
                   "name": "Report problems to Zabbix administrators",
                   "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": "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"
                           }
                       }
                   ],
                   "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": "Updated: {TRIGGER.NAME}",
                               "message": "{USER.FULLNAME} updated problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME} with the following message:\r\n{EVENT.UPDATE.MESSAGE}\r\n\r\nCurrent problem status is {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
       }

ディスカバリーアクションの取得

設定されたすべてのディスカバリーアクションを、アクションの条件と操作とともに取得します。このフィルターは"and"評価タイプを使用するため、formula プロパティは空で、eval_formula が自動的に生成されます。