Actionオブジェクト

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

アクション

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

プロパティ タイプ 説明
actionid ID アクションのID。

プロパティの動作:
- 読み取り専用
- 更新操作では必須
esc_period string デフォルトの操作ステップ期間。60秒以上である必要があります。秒数（例: 60、300）、時間のサフィックス付きの値（例: 30s、1m、2h）、またはユーザーマクロを指定できます。

プロパティの動作:
- eventsourceが「トリガーによって生成されたイベント」、「内部イベント」、または「サービスステータスの更新時に生成されたイベント」に設定されている場合にサポート
eventsource integer アクションが処理するイベントのタイプ。

サポートされるイベントタイプの一覧については、イベントの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 - ホストタグの削除。

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

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

プロパティの動作:
- 必須
esc_period string エスカレーションの1ステップの期間（秒）。60秒より長くする必要があります。秒数（例: 60、300）、時間のサフィックス付きの値（例: 30s、1m、2h）、またはユーザーマクロを指定できます。0または0sに設定すると、デフォルトのアクションエスカレーション期間が使用されます。

デフォルト: 0s。

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

デフォルト: 1。

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

デフォルト: 1。

プロパティの動作:
- Action object の 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 が「ホストタグの追加」または「ホストタグの削除」に設定されている場合にサポート。

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

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

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

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

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

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

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

アクション実行条件

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

Property Type Description
conditiontype integer 条件のタイプ。

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

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

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

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

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

Condition Condition name Supported operators Expected value
14 イベント確認済み = イベントが確認済みかどうか。

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

アクションのリカバリー実行内容

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

プロパティ 型 説明
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 が設定されていない場合は 必須

アクションフィルター

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

プロパティ Type 説明
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 が「カスタム式」に設定されている場合は 必須

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

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

Property Type Description
conditiontype integer 条件のタイプ。

Action object の eventsource が「トリガーによって生成されたイベント」に設定されている場合の使用可能な値:
0 - ホストグループ;
1 - ホスト;
2 - トリガー;
3 - イベント名;
4 - トリガーの深刻度;
6 - 期間;
13 - ホストテンプレート;
16 - 障害が抑制されているかどうか;
25 - イベントタグ;
26 - イベントタグの値。

Action object の eventsource が「ディスカバリールールによって生成されたイベント」に設定されている場合の使用可能な値:
7 - ホストIP;
8 - 検出されたサービスのタイプ;
9 - 検出されたサービスのポート;
10 - ディスカバリーのステータス;
11 - 稼働時間または停止時間;
12 - 受信値;
18 - ディスカバリールール;
19 - ディスカリーチェック;
20 - プロキシ;
21 - ディスカリーオブジェクト;
29 - プロキシグループ。

Action object の eventsource が「アクティブエージェントの自動登録によって生成されたイベント」に設定されている場合の使用可能な値:
20 - プロキシ;
22 - ホスト名;
24 - ホストメタデータ;
29 - プロキシグループ。

Action object の eventsource が「内部イベント」に設定されている場合の使用可能な値:
0 - ホストグループ;
1 - ホスト;
13 - ホストテンプレート;
23 - イベントタイプ;
25 - イベントタグ;
26 - イベントタグの値。

Action object の eventsource が「サービスステータスの更新時に生成されたイベント」に設定されている場合の使用可能な値:
25 - イベントタグ;
26 - イベントタグの値;
27 - サービス;
28 - サービス名。

Property behavior:
- required
value string 比較対象の値。

Property behavior:
- required
value2 string 比較対象の副次的な値。

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

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

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

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

Condition Condition name Supported operators Expected value
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 サービス名 等しい、
等しくない		 サービス名。
29 プロキシグループ 等しい、
等しくない		 プロキシグループのID。