Actionオブジェクト

次のオブジェクトは、actionAPIに直接関連しています。

Action

actionオブジェクトには次のプロパティがあります。

プロパティ	タイプ	説明
actionid	string	アクションのID。プロパティの動作: - 読取専用 - 更新操作の場合、必須
esc_period	string	デフォルトの操作ステップ期間。 60秒以上でなければなりません。秒、サフィックス付きのタイムユニット、およびユーザーマクロを受け入れます。プロパティの動作: - `eventsource` が"トリガーによって作成されたイベント"、"内部イベント"または"サービスステータス更新時に作成されたイベント"に設定されている場合、サポート
eventsource	integer	アクションが処理するイベントの種類。サポートされているイベントタイプのリストについては、eventの"source"プロパティを参照してください。プロパティの動作: - 定数 - 作成操作の場合必須
name	string	アクション名。プロパティの動作: - 作成操作の場合必須
status	integer	アクションが有効か無効か。有効な値 : 0 - (デフォルト) 有効 1 - 無効
pause_symptoms	integer	イベントが副次的なイベントの場合にエスカレーションを一時停止するか。有効な値: 0 - 一時停止しない 1 - (デフォルト) 一時停止するプロパティの動作: - `eventsource`が"トリガーによって作成されたイベント"に設定されている場合サポート
pause_suppressed	integer	メンテナンス期間中にエスカレーションを一時停止するか。有効な値: 0 - 一時停止しない 1 - (デフォルト) 一時停止するプロパティの動作: - `eventsource`が"トリガーによって作成されたイベント"に設定されている場合サポート
notify_if_canceled	integer	エスカレーションがキャンセルされたときに通知するか。有効な値: 0 - 通知しない 1 - (デフォルト) 通知するプロパティの動作: - `eventsource`が"トリガーによって作成されたイベント"に設定されている場合サポート

アクションオペレーション

アクションオペレーションオブジェクトは、アクションが実行されたときに実行されるオペレーションを定義します。以下のプロパティを持ちます。

プロパティ	型	説明
operationtype	integer	オペレーションのタイプ。可能な値： 0 - メッセージ送信; 1 - グローバルスクリプト; 2 - ホスト追加; 3 - ホスト削除; 4 - ホストグループに追加; 5 - ホストグループから削除; 6 - テンプレートリンク; 7 - テンプレートリンク解除; 8 - ホスト有効化; 9 - ホスト無効化; 10 - ホストインベントリモード設定; 13 - ホストタグ追加; 14 - ホストタグ削除。アクションオブジェクトの`eventsource`が「トリガーによって作成されたイベント」または「サービスステータス更新時に作成されたイベント」に設定されている場合の可能な値： 0 - 「メッセージ送信」; 1 - 「グローバルスクリプト」。アクションオブジェクトの`eventsource`が「内部イベント」に設定されている場合の可能な値： 0 - 「メッセージ送信」。プロパティの動作： - 必須
esc_period	string	エスカレーションステップの継続時間（秒）。60秒より大きい必要があります。秒数、サフィックス付きの時間単位、またはユーザーマクロを受け付けます。0または0sに設定すると、デフォルトのアクションエスカレーション期間が使用されます。デフォルト：0s。プロパティの動作： - アクションオブジェクトの`eventsource`が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合にサポート
esc_step_from	integer	エスカレーションを開始するステップ。デフォルト：1。プロパティの動作： - アクションオブジェクトの`eventsource`が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合にサポート
esc_step_to	integer	エスカレーションを終了するステップ。デフォルト：1。プロパティの動作： - アクションオブジェクトの`eventsource`が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合にサポート
evaltype	integer	オペレーション条件の評価方法。可能な値： 0 - (デフォルト) And/Or; 1 - And; 2 - Or。
opcommand	object	実行するグローバルスクリプト。グローバルスクリプトには`scriptid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「グローバルスクリプト」に設定されている場合は必須
opcommand_grp	array	グローバルスクリプトを実行するホストグループ。ホストグループには`groupid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「グローバルスクリプト」に設定され、`opcommand_hst`が設定されていない場合は必須
opcommand_hst	array	グローバルスクリプトを実行するホスト。ホストには`hostid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「グローバルスクリプト」に設定され、`opcommand_grp`が設定されていない場合は必須
opconditions	array	トリガーアクションに使用されるオペレーション条件。オペレーション条件オブジェクトは以下で詳細に説明されています。
opgroup	array	ホストを追加するホストグループ。ホストグループには`groupid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「ホストグループに追加」または「ホストグループから削除」に設定されている場合は必須
opmessage	object	オペレーションによって送信されるメッセージに関するデータを含むオブジェクト。オペレーションメッセージオブジェクトは以下で詳細に説明されています。プロパティの動作： - `operationtype`が「メッセージ送信」に設定されている場合は必須
opmessage_grp	array	メッセージを送信するユーザーグループ。ユーザーグループには`usrgrpid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「メッセージ送信」に設定され、`opmessage_usr`が設定されていない場合は必須
opmessage_usr	array	メッセージを送信するユーザー。ユーザーには`userid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「メッセージ送信」に設定され、`opmessage_grp`が設定されていない場合は必須
optemplate	array	ホストにリンクするテンプレート。テンプレートには`templateid`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「テンプレートリンク」または「テンプレートリンク解除」に設定されている場合は必須
opinventory	object	ホストに設定するインベントリモード。インベントリには`inventory_mode`プロパティが定義されている必要があります。プロパティの動作： - `operationtype`が「ホストインベントリモード設定」に設定されている場合は必須
optag	array	追加または削除するホストタグ。タグには`tag`プロパティが定義されている必要があります。 `value`プロパティはオプションです。プロパティの動作： - `operationtype`が「ホストタグ追加」または「ホストタグ削除」に設定されている場合にサポート。

Action operation message

operation messageオブジェクトには、オペレーションによって送信されるメッセージに関するデータが含まれています。以下のような性質を持っています。

プロパティ	タイプ	説明
default_msg	integer	デフォルトのアクションメッセージテキストと件名を使用するかどうか。有効な値: 0 - オペレーションからのデータを使用 1 - (デフォルト) メディアタイプからのデータを使用
mediatypeid	ID	メッセージの送信に使用されるメディアタイプのID。プロパティの動作: - Action operationオブジェクト、Action recovery operationオブジェクト、またはAction update operationオブジェクトの`operationtype`が"send message"に設定されている場合、あるいはAction update operationオブジェクトの`operationtype`が"notify all involved"に設定されている場合、サポート
message	string	オペレーションメッセージ本文。プロパティの動作: - `default_msg`が"use the data from the operation"に設定されている場合、サポート
subject	string	オペレーションメッセージ件名。プロパティの動作: - `default_msg`が"use the data from the operation"に設定されている場合、サポート

Action operation condition

Action operation conditionオブジェクトは、現在の操作を実行するために満たさなければならない条件を定義します。次のプロパティがあります。

プロパティ	タイプ	説明
conditiontype	integer	条件のタイプ。有効な値: 14 - イベントが確認されたプロパティの動作: - 必須
value	string	比較する値。プロパティの動作: - 必須
operator	integer	条件演算子。有効な値: 0 - (デフォルト) =

次の演算子と値は、各操作条件タイプでサポートされています。

条件	条件名	対応演算子	期待値
14	イベント承認	=	イベントが承認されたか。可能な値: 0 - 承認されていない 1 - 承認されている

Action recovery operation

Action recovery operationオブジェクトは、障害が復旧されたときに実行される操作を定義します。リカバリオペレーションはトリガー、内部、およびサービスアクションのみに可能です。次のプロパティがあります。

プロパティ	タイプ	説明
operationtype	integer	オペレーションタイプ。 Actionオブジェクトの`eventsource`が"event created by a trigger"または"event created on service status update"に設定されている場合、有効な値: 0 - メッセージを送信 1 - グローバルスクリプト 11 - 関係者全員に通知 Actionオブジェクトの`eventsource`が"internal event"に設定されている場合、有効な値: 0 - メッセージを送信 11 - 関係者全員に通知プロパティの動作: - 必須
opcommand	object	実行されるグローバルスクリプト。グローバルスクリプトは`scriptid`プロパティが定義されている必要があります。プロパティの動作: - `operationtype`に"global script"が設定されている場合、必須
opcommand_grp	array	グローバルスクリプトを実行するホストグループ。ホストグループは`groupid`プロパティが定義されている必要があります。プロパティの動作: - Actionオブジェクトの`eventsource`が"event created by a trigger"、`operationtype`が "global script"に設定されており、`opcommand_hst`には何も設定されていない場合、必須
opcommand_hst	array	グローバルスクリプトを実行するホスト。ホストは`hostid`プロパティが定義されている必要があります。プロパティの動作: - Actionオブジェクトの`eventsource`が"event created by a trigger"、`operationtype`が "global script"に設定されており、`opcommand_hst`には何も設定されていない場合、必須
opmessage	object	リカバリオペレーションによって送信されたメッセージに関するデータを含むオブジェクト。操作メッセージオブジェクトは上記で詳しく説明しています。プロパティの動作: - `operationtype`に"send message"が設定されている場合、必須
opmessage_grp	array	メッセージを送信するユーザーグループ。ユーザーグループは`usrgrpid`プロパティが定義されている必要がありますプロパティの動作: - `operationtype`に"send message"が設定されており、`opmessage_usr`には何も設定されていない場合、必須
opmessage_usr	array	メッセージを送信するユーザー。ユーザーは`userid`プロパティが定義されている必要があります。プロパティの動作: - `operationtype`に"send message"が設定されており、`opmessage_grp`には何も設定されていない場合、必須

Action update operation

アクション更新操作オブジェクトは、問題が更新された際に実行される操作（コメントの追加、確認、重大度の変更、または手動でクローズ）を定義します。更新操作は、トリガーアクションとサービスアクションに対してのみ可能です。以下のプロパティがあります。

プロパティ	タイプ	説明
操作タイプ	整数	操作のタイプ有効な値: 0 - メッセージを送信する。 1 - グローバルスクリプトを実行する。 12 - 関係者全員に通知する。プロパティの動作: - 必須
opcommand	オブジェクト	実行するグローバルスクリプトグローバルスクリプトには、`scriptid` プロパティが定義されている必要があります。プロパティの動作: - `operationtype` が「グローバルスクリプト」に設定されている場合は必須です。
opcommand_grp	配列	グローバルスクリプトを実行するホストグループホストグループには、`groupid` プロパティが定義されている必要があります。プロパティの動作: - アクションオブジェクトの `eventsource` が「トリガーによって作成されたイベント」に設定され、`operationtype` が「グローバルスクリプト」に設定され、`opcommand_hst` が設定されていない場合は必須です。
opcommand_hst	array	グローバルスクリプトを実行するホストホストには `hostid` プロパティが定義されている必要があります。プロパティの動作: - アクションオブジェクトの `eventsource` が「トリガーによって作成されたイベント」に設定され、`operationtype` が「グローバルスクリプト」に設定され、`opcommand_grp` が設定されていない場合は必須です。
opmessage	object	更新操作によって送信されたメッセージに関するデータを含むオブジェクト操作メッセージオブジェクトについては、上記で詳しく説明しています。
opmessage_grp	array	メッセージを送信するユーザーグループユーザーグループには `usrgrpid` プロパティが定義されている必要があります。プロパティの動作: - `operationtype` が "send message" に設定され、`opmessage_usr` が設定されていない場合は必須です。
opmessage_usr	array	メッセージを送信するユーザーユーザーには `userid` プロパティが定義されている必要があります。プロパティの動作: - `operationtype` が "send message" に設定され、`opmessage_grp` が設定されていない場合は必須です。

アクションフィルター

アクションフィルターオブジェクトは、設定されたアクション操作を実行するために満たす必要がある条件のセットを定義します。以下のプロパティがあります。

プロパティ	タイプ	説明
conditions	array	結果をフィルタリングするために使用するフィルター条件のセット。条件は、式内での配置順に並べ替えられます。プロパティの動作: - 必須
evaltype	integer	フィルター条件の評価方法。可能な値: 0 - And/Or; 1 - And; 2 - Or; 3 - カスタム式。プロパティの動作: - 必須
eval_formula	string	フィルター条件を評価するために使用される生成された式。式には、`formulaid`で特定のフィルター条件を参照するIDが含まれます。`eval_formula`の値は、カスタム式のフィルターの`formula`の値と等しくなります。プロパティの動作: - 読み取り専用
formula	string	カスタム式のフィルターの条件を評価するために使用されるユーザー定義の式。式には、`formulaid`で特定のフィルター条件を参照するIDが含まれている必要があります。式で使用されるIDは、フィルター条件で定義されたものと完全に一致している必要があります。未使用または省略された条件があってはなりません。プロパティの動作: - `evaltype`が「カスタム式」に設定されている場合は必須

アクションフィルター条件

アクションフィルター条件オブジェクトは、アクション操作を実行する前にチェックする必要がある特定の条件を定義します。

プロパティ	タイプ	説明
conditiontype	integer	条件のタイプ。アクションオブジェクトの`eventsource`が「トリガーによって作成されたイベント」に設定されている場合の値: 0 - ホストグループ; 1 - ホスト; 2 - トリガー; 3 - イベント名; 4 - トリガーの深刻度; 6 - 時間帯; 13 - ホストテンプレート; 16 - 問題が抑制されている; 25 - イベントタグ; 26 - イベントタグ値。アクションオブジェクトの`eventsource`が「ディスカバリールールによって作成されたイベント」に設定されている場合の値: 7 - ホストIP; 8 - 検出されたサービスのタイプ; 9 - 検出されたサービスのポート; 10 - ディスカバリーステータス; 11 - アップタイムまたはダウンタイムの期間; 12 - 受信値; 18 - ディスカバリールール; 19 - ディスカバリーチェック; 20 - プロキシ; 21 - ディスカバリーオブジェクト。アクションオブジェクトの`eventsource`が「アクティブエージェントの自動登録によって作成されたイベント」に設定されている場合の値: 20 - プロキシ; 22 - ホスト名; 24 - ホストメタデータ。アクションオブジェクトの`eventsource`が「内部イベント」に設定されている場合の値: 0 - ホストグループ; 1 - ホスト; 13 - ホストテンプレート; 23 - イベントタイプ; 25 - イベントタグ; 26 - イベントタグ値。アクションオブジェクトの`eventsource`が「サービスステータスの更新時に作成されたイベント」に設定されている場合の値: 25 - イベントタグ; 26 - イベントタグ値; 27 - サービス; 28 - サービス名。プロパティの動作: - 必須
value	string	比較する値。プロパティの動作: - 必須
value2	string	比較する2番目の値。プロパティの動作: - アクションオブジェクトの`eventsource`が「トリガーによって作成されたイベント」に設定されており、`conditiontype`がトリガーアクションのいずれかの値に設定されていて、条件タイプ（下記参照）が「26」の場合は必須 - アクションオブジェクトの`eventsource`が「内部イベント」に設定されており、`conditiontype`が内部アクションのいずれかの値に設定されていて、条件タイプ（下記参照）が「26」の場合は必須 - アクションオブジェクトの`eventsource`が「サービスステータスの更新時に作成されたイベント」に設定されており、`conditiontype`がサービスアクションのいずれかの値に設定されていて、条件タイプ（下記参照）が「26」の場合は必須
formulaid	string	カスタム式から条件を参照するために使用される任意の一意のID。大文字のみ使用可能。フィルター条件を変更する際はユーザーがIDを定義する必要がありますが、その後リクエスト時には新たに生成されます。
operator	integer	条件演算子。可能な値: 0 - (デフォルト) 等しい; 1 - 等しくない; 2 - 含む; 3 - 含まない; 4 - 範囲内; 5 - 以上; 6 - 以下; 7 - 範囲外; 8 - 正規表現一致; 9 - 正規表現不一致; 10 - はい; 11 - いいえ。

さまざまなタイプの式でフィルターを使用する方法をよりよく理解するには、action.getおよびaction.createメソッドページの例を参照してください。

各条件タイプでサポートされる演算子と値は以下の通りです。

条件	条件名	サポートされる演算子	期待される値
0	ホストグループ	等しい, 等しくない	ホストグループID。
1	ホスト	等しい, 等しくない	ホストID。
2	トリガー	等しい, 等しくない	トリガーID。
3	イベント名	含む, 含まない	イベント名。
4	トリガーの深刻度	等しい, 等しくない, 以上, 以下	トリガーの深刻度。サポートされているトリガーの深刻度についてはトリガー`severity`プロパティを参照してください。
5	トリガー値	等しい	トリガー値。サポートされているトリガー値についてはトリガー`value`プロパティを参照してください。
6	時間帯	範囲内, 範囲外	イベントがトリガーされた時刻を時間帯で指定。
7	ホストIP	等しい, 等しくない	カンマ区切りで指定した1つまたは複数のIP範囲。サポートされているIP範囲の形式についてはネットワークディスカバリ設定セクションを参照してください。
8	検出されたサービスのタイプ	等しい, 等しくない	検出されたサービスのタイプ。サービスのタイプはサービス検出に使用されたディスカバリーチェックのタイプと一致します。サポートされているタイプについてはディスカバリーチェック`type`プロパティを参照してください。
9	検出されたサービスのポート	等しい, 等しくない	カンマ区切りで指定した1つまたは複数のポート範囲。
10	ディスカバリーステータス	等しい	検出されたオブジェクトのステータス。可能な値: 0 - ホストまたはサービスが稼働中; 1 - ホストまたはサービスが停止中; 2 - ホストまたはサービスが検出された; 3 - ホストまたはサービスが消失。
11	アップタイムまたはダウンタイムの期間	以上, 以下	検出されたオブジェクトが現在のステータスにある秒数。
12	受信値	等しい, 等しくない, 以上, 以下, 含む, 含まない	Zabbixエージェント、SNMPv1、SNMPv2、SNMPv3ディスカバリーチェック実行時に返された値。
13	ホストテンプレート	等しい, 等しくない	リンクされたテンプレートID。
16	問題が抑制されている	はい, いいえ	値は不要: 「はい」演算子は問題が抑制されていること、「いいえ」は抑制されていないことを意味します。
18	ディスカバリールール	等しい, 等しくない	ディスカバリールールのID。
19	ディスカバリーチェック	等しい, 等しくない	ディスカバリーチェックのID。
20	プロキシ	等しい, 等しくない	プロキシのID。
21	ディスカバリーオブジェクト	等しい	ディスカバリーイベントをトリガーしたオブジェクトのタイプ。可能な値: 1 - 検出されたホスト; 2 - 検出されたサービス。
22	ホスト名	含む, 含まない, 正規表現一致, 正規表現不一致	ホスト名。自動登録条件で正規表現一致および正規表現不一致演算子を使用する場合は正規表現がサポートされます。
23	イベントタイプ	等しい	特定の内部イベント。可能な値: 0 - アイテムが「サポートされていない」状態; 1 - アイテムが「通常」状態; 2 - LLDルールが「サポートされていない」状態; 3 - LLDルールが「通常」状態; 4 - トリガーが「不明」状態; 5 - トリガーが「通常」状態。
24	ホストメタデータ	含む, 含まない, 正規表現一致, 正規表現不一致	自動登録されたホストのメタデータ。正規表現一致および正規表現不一致演算子を使用する場合は正規表現がサポートされます。
25	タグ	等しい, 等しくない, 含む, 含まない	イベントタグ。
26	タグ値	等しい, 等しくない, 含む, 含まない	イベントタグ値。
27	サービス	等しい, 等しくない	サービスID。
28	サービス名	等しい, 等しくない	サービス名。

Documentation