Actionオブジェクト

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

アクション

アクションオブジェクトには以下のプロパティがあります。

プロパティ 型 説明
actionid ID アクションの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 が「トリガーによって作成されたイベント」に設定されている場合に サポート

アクションの実行内容

アクション実行内容オブジェクトは、アクションが実行されたときに実施される操作を定義します。
このオブジェクトには、以下のプロパティがあります。

Property Type Description
operationtype integer 操作の種類。

指定可能な値:
0 - メッセージ送信;
1 - グローバルスクリプト;
2 - ホストの追加;
3 - ホストの削除;
4 - ホストグループへの追加;
5 - ホストグループからの削除;
6 - テンプレートのリンク;
7 - テンプレートのリンク解除;
8 - ホストの有効化;
9 - ホストの無効化;
10 - ホストインベントリモードの設定;
13 - ホストタグの追加;
14 - ホストタグの削除。

Action object の eventsource が「トリガーによって作成されたイベント」または「サービスステータス更新時に作成されたイベント」に設定されている場合の指定可能な値:
0 - 「メッセージ送信」;
1 - 「グローバルスクリプト」。

Action object の eventsource が「内部イベント」に設定されている場合の指定可能な値:
0 - 「メッセージ送信」。

Property behavior:
- required
esc_period string エスカレーションステップの期間（秒）。60秒より大きい必要があります。秒数、サフィックス付きの時間単位、またはユーザーマクロを指定できます。0 または 0s に設定した場合、デフォルトのアクションエスカレーション期間が使用されます。

デフォルト: 0s。

Property behavior:
- supported if Action object の eventsource が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合
esc_step_from integer エスカレーションを開始するステップ。

デフォルト: 1。

Property behavior:
- supported if Action object の eventsource が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合
esc_step_to integer エスカレーションを終了するステップ。

デフォルト: 1。

Property behavior:
- supported if Action object の eventsource が「トリガーによって作成されたイベント」、「内部イベント」、または「サービスステータス更新時に作成されたイベント」に設定されている場合
evaltype integer 実行条件の評価方法。

指定可能な値:
0 - (default) And/Or;
1 - And;
2 - Or。
opcommand object 実行するグローバルスクリプト。

グローバルスクリプトでは scriptid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「グローバルスクリプト」に設定されている場合
opcommand_grp array グローバルスクリプトを実行するホストグループ。

ホストグループでは groupid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「グローバルスクリプト」に設定され、opcommand_hst が設定されていない場合
opcommand_hst array グローバルスクリプトを実行するホスト。

ホストでは hostid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「グローバルスクリプト」に設定され、opcommand_grp が設定されていない場合
opconditions array トリガーアクションで使用される実行条件。

実行条件オブジェクトについては、以下で詳しく説明しています。
opgroup array ホストを追加するホストグループ。

ホストグループでは groupid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「ホストグループへの追加」または「ホストグループからの削除」に設定されている場合
opmessage object 実行内容によって送信されるメッセージに関するデータを含むオブジェクト。

実行メッセージオブジェクトについては、以下で詳しく説明しています。

Property behavior:
- required if operationtype が「メッセージ送信」に設定されている場合
opmessage_grp array メッセージの送信先ユーザーグループ。

ユーザーグループでは usrgrpid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「メッセージ送信」に設定され、opmessage_usr が設定されていない場合
opmessage_usr array メッセージの送信先ユーザー。

ユーザーでは userid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「メッセージ送信」に設定され、opmessage_grp が設定されていない場合
optemplate array ホストにリンクするテンプレート。

テンプレートでは templateid プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「テンプレートのリンク」または「テンプレートのリンク解除」に設定されている場合
opinventory object ホストに設定するインベントリモード。

インベントリでは inventory_mode プロパティが定義されている必要があります。

Property behavior:
- required if operationtype が「ホストインベントリモードの設定」に設定されている場合
optag array 追加または削除するホストタグ。

タグでは tag プロパティが定義されている必要があります。
value プロパティは任意です。

Property behavior:
- supported if operationtype が「ホストタグの追加」または「ホストタグの削除」に設定されている場合

アクション実行メッセージ

実行メッセージオブジェクトには、実行によって送信されるメッセージに関するデータが含まれます。次のプロパティがあります。

プロパティ 型 説明
default_msg integer デフォルトのアクションメッセージ本文および件名を使用するかどうか。

指定可能な値:
0 - 実行のデータを使用;
1 - (デフォルト) メディアタイプのデータを使用。
mediatypeid ID メッセージの送信に使用されるメディアタイプのID。

プロパティの動作:
- アクション実行オブジェクト、アクション復旧実行オブジェクト、または アクション更新実行オブジェクト の operationtype が「メッセージ送信」に設定されている場合、または アクション更新実行オブジェクト の operationtype が「関係者全員に通知」に設定されている場合に supported
message string 実行メッセージの本文。

プロパティの動作:
- default_msg が「実行のデータを使用」に設定されている場合に supported
subject string 実行メッセージの件名。

プロパティの動作:
- default_msg が「実行のデータを使用」に設定されている場合に supported

アクション実行条件

アクション実行条件オブジェクトは、現在の実行を行うために満たす必要がある条件を定義します。以下のプロパティがあります。

プロパティ Type 説明
conditiontype integer 条件のタイプ。

指定可能な値:
14 - イベント確認済み。

プロパティの動作:
- 必須
value string 比較する値。

プロパティの動作:
- 必須
operator integer 条件演算子。

指定可能な値:
0 - (デフォルト) =

以下の演算子と値が、各実行条件タイプでサポートされています。

条件 条件名 サポートされる演算子 期待される値
14 イベント確認済み = イベントが確認済みかどうか。

指定可能な値:
0 - 未確認;
1 - 確認済み。

アクションの復旧時実行内容

アクションの復旧時実行内容オブジェクトは、障害が解決されたときに実行される操作を定義します。
復旧時実行内容が可能なのは、トリガー、内部、およびサービスアクションのみです。
以下のプロパティがあります。

Property Type Description
operationtype integer 操作の種類。

アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」または「サービスステータス更新時に作成されたイベント」に設定されている場合の使用可能な値:
0 - メッセージ送信;
1 - グローバルスクリプト;
11 - 関係者全員に通知。

アクションオブジェクト の eventsource が「内部イベント」に設定されている場合の使用可能な値:
0 - メッセージ送信;
11 - 関係者全員に通知。

プロパティの動作:
- 必須
opcommand object 実行するグローバルスクリプト。

グローバルスクリプトでは scriptid プロパティを定義する必要があります。

プロパティの動作:
- operationtype が「グローバルスクリプト」に設定されている場合は 必須
opcommand_grp array グローバルスクリプトを実行するホストグループ。

ホストグループでは groupid プロパティを定義する必要があります。

プロパティの動作:
- アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」に設定され、operationtype が「グローバルスクリプト」に設定され、かつ opcommand_hst が設定されていない場合は 必須
opcommand_hst array グローバルスクリプトを実行するホスト。

ホストでは hostid プロパティを定義する必要があります。

プロパティの動作:
- アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」に設定され、operationtype が「グローバルスクリプト」に設定され、かつ opcommand_grp が設定されていない場合は 必須
opmessage object 復旧時実行内容によって送信されるメッセージに関するデータを含むオブジェクト。

実行内容メッセージオブジェクトの詳細は、上記の説明を参照してください。

プロパティの動作:
- operationtype が「メッセージ送信」に設定されている場合は 必須
opmessage_grp array メッセージの送信先となるユーザーグループ。

ユーザーグループでは usrgrpid プロパティを定義する必要があります。

プロパティの動作:
- operationtype が「メッセージ送信」に設定され、かつ opmessage_usr が設定されていない場合は 必須
opmessage_usr array メッセージの送信先となるユーザー。

ユーザーでは userid プロパティを定義する必要があります。

プロパティの動作:
- operationtype が「メッセージ送信」に設定され、かつ opmessage_grp が設定されていない場合は 必須

アクション更新操作

アクション更新操作オブジェクトは、障害が更新されたとき （コメントの追加、確認、深刻度の変更、または手動クローズ）に実行される操作を定義します。 更新操作は、トリガーアクションおよびサービスアクションでのみ使用できます。 このオブジェクトには、以下のプロパティがあります。

Property Type Description
operationtype integer 操作の種類。

指定可能な値:
0 - メッセージ送信;
1 - グローバルスクリプト;
12 - 関係者全員に通知。

プロパティの動作:
- 必須
opcommand object 実行するグローバルスクリプト。

グローバルスクリプトでは scriptid プロパティを定義する必要があります。

プロパティの動作:
- operationtype が「グローバルスクリプト」に設定されている場合は 必須
opcommand_grp array グローバルスクリプトを実行するホストグループ。

ホストグループでは groupid プロパティを定義する必要があります。

プロパティの動作:
- アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」に設定され、operationtype が「グローバルスクリプト」に設定され、かつ opcommand_hst が設定されていない場合は 必須
opcommand_hst array グローバルスクリプトを実行するホスト。

ホストでは hostid プロパティを定義する必要があります。

プロパティの動作:
- アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」に設定され、operationtype が「グローバルスクリプト」に設定され、かつ opcommand_grp が設定されていない場合は 必須
opmessage object 更新操作によって送信されるメッセージに関するデータを含むオブジェクト。

操作メッセージオブジェクトについては、上記で詳しく説明しています。
opmessage_grp array メッセージの送信先となるユーザーグループ。

ユーザーグループでは usrgrpid プロパティを定義する必要があります。

プロパティの動作:
- operationtype が「メッセージ送信」に設定され、opmessage_usr が設定されていない場合は 必須
opmessage_usr array メッセージの送信先となるユーザー。

ユーザーでは userid プロパティを定義する必要があります。

プロパティの動作:
- operationtype が「メッセージ送信」に設定され、opmessage_grp が設定されていない場合は 必須

アクションフィルター

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

プロパティ 型 説明
conditions array 結果をフィルタリングするために使用するフィルター条件のセット。条件は、formula内で配置された順序でソートされます。

プロパティの動作:
- 必須
evaltype integer フィルター条件の評価方法。

使用可能な値:
0 - And/Or;
1 - And;
2 - Or;
3 - カスタム式。

プロパティの動作:
- 必須
eval_formula string フィルター条件の評価に使用される生成済みの式。この式には、formulaid によって特定のフィルター条件を参照するIDが含まれます。カスタム式を持つフィルターでは、eval_formula の値は formula の値と同じです。

プロパティの動作:
- 読み取り専用
formula string カスタム式を持つフィルターの条件評価に使用する、ユーザー定義の式。この式には、formulaid によって特定のフィルター条件を参照するIDを含める必要があります。式で使用するIDは、フィルター条件で定義されたものと完全に一致している必要があります。どの条件も未使用のままにしたり、省略したりすることはできません。

プロパティの動作:
- evaltype が「カスタム式」に設定されている場合は 必須

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

アクションフィルター条件オブジェクトは、アクションの実行操作を開始する前に 確認しなければならない特定の条件を定義します。

プロパティ Type 説明
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 - サービス名。

Property behavior:
- required
value string 比較する値。

Property behavior:
- required
value2 string 比較する第2の値。

Property behavior:
- アクションオブジェクト の eventsource が「トリガーによって作成されたイベント」に設定され、conditiontype がトリガーアクションで使用可能な任意の値に設定され、かつ条件タイプ（下記参照）が「26」の場合は required
- アクションオブジェクト の eventsource が「内部イベント」に設定され、conditiontype が内部アクションで使用可能な任意の値に設定され、かつ条件タイプ（下記参照）が「26」の場合は required
- アクションオブジェクト の eventsource が「サービスステータス更新時に作成されたイベント」に設定され、conditiontype がサービスアクションで使用可能な任意の値に設定され、かつ条件タイプ（下記参照）が「26」の場合は required
formulaid string カスタム式から条件を参照するために使用される任意の一意なID。使用できるのは大文字のみです。このIDはフィルター条件を変更する際にユーザーが定義する必要がありますが、その後に条件を要求すると新たに生成されます。
operator integer 条件の演算子。

使用可能な値:
0 - (default) 等しい;
1 - 等しくない;
2 - 含む;
3 - 含まない;
4 - in;
5 - 以上;
6 - 以下;
7 - not in;
8 - 一致する;
9 - 一致しない;
10 - はい;
11 - いいえ。

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

以下の演算子と値が、各条件タイプでサポートされています。

条件 条件名 サポートされる演算子 想定される値
0 ホストグループ 等しい,
等しくない		 ホストグループID。
1 ホスト 等しい,
等しくない		 ホストID。
2 トリガー 等しい,
等しくない		 トリガーID。
3 イベント名 含む,
含まない		 イベント名。
4 トリガーの深刻度 等しい,
等しくない,
以上,
以下		 トリガーの深刻度。サポートされるトリガー深刻度の一覧については、trigger severity property を参照してください。
5 トリガー値 等しい トリガー値。サポートされるトリガー値の一覧については、trigger value property を参照してください。
6 時間帯 in, not in イベントがトリガーされた時刻を time period として指定します。
7 ホストIP 等しい,
等しくない		 確認する1つまたは複数のIP範囲をカンマ区切りで指定します。サポートされるIP範囲の形式の詳細については、ネットワークディスカバリ設定 セクションを参照してください。
8 検出されたサービスのタイプ 等しい,
等しくない		 検出されたサービスのタイプ。サービスのタイプは、そのサービスの検出に使用されたディスカバリチェックのタイプと一致します。サポートされるタイプの一覧については、discovery check type property を参照してください。
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 ホスト名 含む,
含まない,
一致する,
一致しない		 ホスト名。
自動登録条件では、matches および does not match 演算子で正規表現を使用できます。
23 イベントタイプ 等しい 特定の内部イベント。

使用可能な値:
0 - アイテムが「未サポート」状態;
1 - アイテムが「正常」状態;
2 - LLDルールが「未サポート」状態;
3 - LLDルールが「正常」状態;
4 - トリガーが「不明」状態;
5 - トリガーが「正常」状態。
24 ホストメタデータ 含む,
含まない,
一致する,
一致しない		 自動登録されたホストのメタデータ。
matches および does not match 演算子では正規表現を使用できます。
25 タグ 等しい,
等しくない,
含む,
含まない		 イベントタグ。
26 タグ値 等しい,
等しくない,
含む,
含まない		 イベントタグ値。
27 サービス 等しい,
等しくない		 サービスID。
28 サービス名 等しい,
等しくない		 サービス名。