このページで
action.get
説明
integer/array action.get(object parameters)
このメソッドは、指定したパラメーターに応じたアクションを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object) 希望する出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートしています。
| パラメーター | タイプ | 説明 |
|---|---|---|
| actionids | ID/array | 指定されたIDのアクションのみを返します。 |
| groupids | ID/array | アクション条件で指定されたホストグループを使用するアクションのみを返します。 |
| hostids | ID/array | アクション条件で指定されたホストを使用するアクションのみを返します。 |
| triggerids | ID/array | アクション条件で指定されたトリガーを使用するアクションのみを返します。 |
| mediatypeids | ID/array | 指定されたメディアタイプを使用してメッセージを送信するアクションのみを返します。 |
| usrgrpids | ID/array | 指定されたユーザーグループにメッセージを送信するように構成されたアクションのみを返します。 |
| userids | ID/array | 指定されたユーザーにメッセージを送信するように構成されたアクションのみを返します。 |
| scriptids | ID/array | 指定されたスクリプトを実行するように構成されたアクションのみを返します。 |
| selectFilter | query | アクション条件フィルターを含むfilterプロパティを返します。 |
| selectOperations | query | アクション操作を伴うoperationプロパティを返します。 |
| selectRecoveryOperations | query | アクション回復操作を含むrecovery\_operationsプロパティを返します。 |
| selectUpdateOperations | query | アクション更新操作を含むupdate\_operationsプロパティを返します。 |
| sortfield | string/array | 指定されたプロパティによって結果を並べ替えます。 利用可能な値: actionid、name、status |
| countOutput | 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
}
},
"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 state: {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 state 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が自動的に生成されます。
リクエスト :
{
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectFilter": "extend",
"filter": {
"eventsource": 1
}
},
"id": 1
}レスポンス :
{
"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
}参照
ソース
CAction::get() in ui/include/classes/api/services/CAction.php.