Documentation
Table of Contents
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が"トリガーによって作成されたイベント"に設定されている場合サポート |
Action operation
action operationオブジェクトはアクション実行時の操作を設定します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| operationtype | integer | 操作のタイプ。 有効な値: 0 - メッセージを送信する 1 - グローバルスクリプト 2 - ホストを追加する 3 - ホストを削除する 4 - ホストグループに追加する 5 - ホストグループから削除する 6 - テンプレートにリンクを設定する 7 - テンプレートからリンクを解除する 8 - ホストを有効にする 9 - ホストを無効にする 10 - ホストインベントリモードを設定する 13 - ホストタグを追加する 14 - ホストタグを削除する Actionオブジェクトの eventsourceに"トリガーによって作成されたイベント"か"サービスステータスの更新時に作成されたイベント"が設定されている場合の有効な値:0 - "メッセージを送信する" 1 - "グローバルスクリプト" Actionオブジェクトの eventsourceに"内部イベント"が設定されている場合の有効な値:0 - "メッセージを送信する" プロパティの動作 : - 必須 |
| esc_period | string | エスカレーションステップの間隔(秒単位)。60秒より長くする必要があります。 秒、タイムサフィックス付きの単位、およびユーザーマクロを受け入れます。0または0sを設定すると、デフォルトのアクションエスカレーション間隔が使用されます。 デフォルト: 0s プロパティの動作: - Actionオブジェクトの eventsourceに"トリガーによって作成されたイベント"か"内部イベント"、"サービスステータスの更新時に作成されたイベント"が設定されている場合、サポート |
| esc_step_from | integer | エスカレーションを開始するステップ。 デフォルト: 1 プロパティの動作: - Actionオブジェクトの eventsourceに"トリガーによって作成されたイベント"か"内部イベント"、"サービスステータスの更新時に作成されたイベント"が設定されている場合、サポート |
| esc_step_to | integer | エスカレーションを終了するステップ。 デフォルト: 1 プロパティの動作: - Actionオブジェクトの eventsourceに"トリガーによって作成されたイベント"か"内部イベント"、"サービスステータスの更新時に作成されたイベント"が設定されている場合、サポート |
| evaltype | integer | 動作条件の評価方法。 有効な値: 0 - (デフォルト) AND/OR 1 - AND 2 - OR |
| opcommand | object | 実行されるグローバルスクリプト。 グローバルスクリプトには scriptidプロパティが定義されている必要があります。プロパティの動作: - operationtypeに"global script"が設定されている場合、必須 |
| 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
action update operation オブジェクトは、障害が更新されたときに実行される操作を定義します (コメント、承認、深刻度の変更、または手動でクローズ)。 トリガーとサービスのアクションは、更新操作が可能です。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| operationid | string | (読取専用) アクションオペレーションID |
| operationtype (必須) |
integer | オペレーションタイプ トリガーとサービス アクションの有効な値: 0 - メッセージを送信 1 - グローバル スクリプト 12 - 関係者全員に通知 |
| opcommand | object | オペレーションによって実行されるグローバル アクション タイプ スクリプトに関するデータを含むオブジェクト' 各オブジェクトには次のプロパティが 1 つあります。 scriptid - (string) アクション タイプ スクリプトの ID'必須 グローバル スクリプト操作' |
| opcommand_grp | array | グローバル スクリプトを実行するホスト グループ 各オブジェクトには次のプロパティがあります groupid - (string) ホスト グループの IDopcommand_hst が設定されていない場合、グローバル スクリプト操作に必要です。 |
| opcommand_hst | array | グローバル スクリプトを実行するホスト 各オブジェクトには次のプロパティがあります hostid - (文字列) ホストの ID' 0 に設定すると、コマンドは現在のホストで実行されますopcommand_grp が設定されていない場合、グローバル スクリプト操作に必要です。 |
| opmessage | object | 更新操作によって送信されたメッセージに関するデータを含むオブジェクト' 操作メッセージ オブジェクトは こちらで詳細に説明します |
| opmessage_grp | array | メッセージを送信するユーザー グループ 各オブジェクトには次のプロパティがあります。 usrgrpid - (文字列) ユーザー グループの IDopmessage_usr が設定されていない場合、send message オペレーションでのみ必要です。send update message オペレーションでは無視されます。 |
| opmessage_usr | array | メッセージを送信するユーザー 各オブジェクトには次のプロパティがあります。 userid - (文字列) ユーザーの IDopmessage_grpが設定されていない場合、send message オペレーションでのみ必要です。send update message操作では無視されます。 |
Action filter
action filter オブジェクトは、設定されたアクション操作を実行するために満たす必要がある一連の条件を定義します。以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| 条件 | 配列 | 結果をフィルタリングするために使用するフィルター条件のセット。条件は、数式内の配置順に並べ替えられます。 プロパティの動作: - 必須 |
| evaltype | 整数 | フィルター条件の評価方法 有効な値: 0 - かつ/または 1 - かつ 2 - または 3 - カスタム式 プロパティの動作: - 必須 |
| eval_formula | 文字列 | フィルター条件の評価に使用される生成された式。この式には、formulaid によって特定のフィルター条件を参照する ID が含まれます。カスタム式が指定されたフィルターの場合、eval_formula の値は formula の値と同じです。プロパティの動作: - 読み取り専用 |
| formula | 文字列 | カスタム式が指定されたフィルターの条件を評価するために使用されるユーザー定義の式。式には、formulaid によって特定のフィルター条件を参照する ID が含まれている必要があります。式で使用される ID は、フィルター条件で定義されている ID と完全に一致する必要があります。条件を未使用のままにしたり省略したりすることはできません。プロパティの動作: - evaltype が「カスタム式」に設定されている場合、必須 |
Action filter condition
action filter condition オブジェクトは、アクション操作を実行する前にチェックする必要がある特定の条件を定義します。
| プロパティ | タイプ | 説明 |
|---|---|---|
| conditionid | string | (読取専用) 動作条件ID |
| conditiontype (必須) |
integer | 条件のタイプ トリガーアクションに使用可能な値: 0 - ホストグループ 1 - ホスト 2 - トリガー 3 - トリガー名 4 - トリガーの深刻度 6 - 期間 13 - ホストテンプレート 16 - 抑制された障害 25 - イベント タグ 26 - イベントタグ値 < br>ディスカバリアクションに使用可能な値: 7 - ホストIP 8 - 検出されたサービスタイプ 9 - 検出されたサービスポート 10 - 検出ステータス 11 - アップタイムまたはダウンタイム期間 12 - 受信した値 18 - ディスカバリルール 19 - ディスカバリチェック 20 - プロキシ 21 - ディスカバリオブジェクト 自動登録アクションに使用可能な値: 20 - プロキシ 22 - ホスト名 24 - ホストメタデータ 内部アクションに使用可能な値: 0 - ホストグループ 1 - ホスト 13 - ホストテンプレート 23 - イベントタイプ 25 - イベントタグ 26 - イベントタグ値 <br >サービスアクションに使用できる値: 25 - イベントタグ 26 - イベントタグ値 27 - サービス 28 - サービス名 |
| value (必須) |
string | 比較する値 |
| value2 |
string | 比較する二次的な値。 条件タイプが 26 の場合、トリガー、内部、およびサービスアクションに必要です。 |
| actionid | string | (読取専用) 条件が属するアクションID |
| formulaid | string | カスタム式から条件を参照するために使用される任意の一意の ID。 大文字のみを含めることができます。 ID は、フィルタ条件を変更するときにユーザーが定義する必要がありますが、後で要求するときに新たに生成されます。 |
| operator | integer | 条件演算子 使用可能な値: 0 - (デフォルト) 等しい 1 - 等しくない 2 - 含む 3 - 含まない< br>4 - 入っている 5 - 以上 6 - 以下 7 - 入っていない 8 - 一致する 9 - 一致しない 10 - はい 11 - いいえ |
::: notetip さまざまなタイプの式でフィルターを使用する方法をよりよく理解するには、action.get および action.create メソッド ページの例を参照してください。:::
次の演算子と値は、条件の種類ごとにサポートされています。
| 条件 | 条件名 | 対応演算子 | 期待値 |
|---|---|---|---|
| 0 | Host group | equals, does not equal |
ホスト グループ ID |
| 1 | Host | equals, does not equal |
ホスト ID |
| 2 | Trigger | equals, does not equal |
トリガー ID |
| 3 | Trigger name | 含む、 含まない |
トリガー名 |
| 4 | Trigger severity | 等しい 等しくない 以上 以下 |
トリガーの深刻度。サポートされているトリガーの深刻度度のリストについては、トリガーの"深刻度"プロパティ を参照してください。 |
| 5 | Trigger value | equals | トリガー値。 サポートされているトリガー値のリストについては、トリガー "値" プロパティ を参照してください。 |
| 6 | Time period | 入っている,入っていない | イベントがトリガーされた時間帯 |
| 7 | Host IP | equals, does not equal |
確認する 1 つまたは複数の IP 範囲をコンマで区切って指定します。 サポートされている IP 範囲の形式の詳細については、ネットワーク検出構成 セクションを参照してください。 |
| 8 | Discovered service type | equals, does not equal |
検出されたサービスのタイプ。 サービスのタイプは、サービスの検出に使用される検出チェックのタイプと一致します。 サポートされているタイプのリストについては、検出チェックの"タイプ"プロパティ を参照してください。 |
| 9 | Discovered service port | equals, does not equal |
コンマで区切られた 1 つまたは複数のポート範囲。 |
| 10 | Discovery status | equals | 検出されたオブジェクトのステータス 使用可能な値: 0 - ホストまたはサービスが稼働中 1 - ホストまたはサービスが停止中 2 - ホストまたはサービスが検出済み 3 - ホストまたはサービスが失われました。 |
| 11 | Uptime or downtime duration | is greater than or equals, is less than or equals |
検出されたオブジェクトが現在の状態になっている時間(秒単位) |
| 12 | Received values | equals, does not equal, is greater than or equals, is less than or equals, contains, does not contain |
Zabbix エージェント、SNMPv1、SNMPv2、または SNMPv3 の検出チェックを実行したときに返される値 |
| 13 | Host template | equals, does not equal |
リンクされたテンプレート ID |
| 16 | Problem is suppressed | Yes,No | 値は不要です: "Yes" - 障害を抑制します。"No" - 障害を抑制しません。 |
| 18 | Discovery rule | equals does not equal |
ディスカバリルールID |
| 19 | Discovery check | equals does not equal |
ディスカバリチェックID |
| 20 | Proxy | equals does not equal |
プロキシID |
| 21 | Discovery object | equals | ディスカバリイベントをトリガーしたオブジェクトのタイプ 使用可能な値: 1 - 検出されたホスト 2 - 検出されたサービス |
| 22 | Host name | contains does not contain matches does not match |
ホスト名 自動登録条件ではmatches および does not match で正規表現の使用がサポートされています。 |
| 23 | Event type | equals | 特定の内部イベント 使用可能な値: 0 - "サポートされていない"状態のアイテム 1 - "通常"の状態のアイテム 2 - "サポートされていない"状態のLLDルール 3 - "通常"状態の LLD ルール 4 - "不明"状態のトリガー 5 - "通常"状態のトリガー |
| 24 | Host metadata | contains does not contain matches does not match |
自動登録されたホストのメタデータ。 正規表現の使用はmatches および does not matchでサポートされています。 |
| 25 | Tag | equals does not equal contains does not contain |
イベントタグ |
| 26 | Tag value | equals does not equal contains does not contain |
イベントタグ値 |
| 27 | Service | equals does not equal |
サービスID |
| 28 | Service name | equals does not equal |
サービス名 |