trigger.get

説明

integer/array trigger.get(object parameters)

このメソッドを使用すると、指定したパラメータに従ってトリガーを取得できます。

このメソッドは、あらゆる種類のユーザーが利用できます。メソッドの呼び出し権限は、ユーザーのロール設定で取り消すことができます。 詳細は User roles を参照してください。

パラメータ

(object) 目的の出力を定義するパラメータ。

このメソッドは次のパラメータをサポートします。

Parameter Type Description
triggerids ID/array 指定したIDを持つトリガーのみを返します。
groupids ID/array 指定したホストグループまたはテンプレートグループに属するホストまたはテンプレートのトリガーのみを返します。
templateids ID/array 指定したテンプレートに属するトリガーのみを返します。
hostids ID/array 指定したホストに属するトリガーのみを返します。
itemids ID/array 指定したアイテムを含むトリガーのみを返します。
functions string/array 指定した関数を使用するトリガーのみを返します。

サポートされている関数の一覧については、サポートされている関数ページを参照してください。
group string 指定した名前のホストグループまたはテンプレートグループに属するホストまたはテンプレートのトリガーのみを返します。
host string 指定した技術名のホストに属するトリガーのみを返します。
inherited boolean true に設定すると、テンプレートから継承されたトリガーのみを返します。
templated boolean true に設定すると、テンプレートに属するトリガーのみを返します。
dependent boolean true に設定すると、依存関係を持つトリガーのみを返します。false に設定すると、依存関係を持たないトリガーのみを返します。
monitored flag 監視対象のホストに属し、かつ有効なアイテムのみを含む有効なトリガーのみを返します。
active flag 監視対象のホストに属する有効なトリガーのみを返します。
maintenance boolean true に設定すると、メンテナンス中のホストに属する有効なトリガーのみを返します。
withUnacknowledgedEvents flag 未確認のイベントを持つトリガーのみを返します。
withAcknowledgedEvents flag すべてのイベントが確認済みのトリガーのみを返します。
withLastEventUnacknowledged flag 最後のイベントが未確認のトリガーのみを返します。
skipDependent flag 他のトリガーに依存している障害状態のトリガーを除外します。なお、他のトリガーが無効、無効なアイテムを持つ、または無効なアイテムのホストに属する場合は、そのトリガーは無視されます。
lastChangeSince timestamp 指定した時刻以降に状態が変化したトリガーのみを返します。
lastChangeTill timestamp 指定した時刻以前に状態が変化したトリガーのみを返します。
only_true flag 最近障害状態になったトリガーのみを返します。
min_severity integer 指定した深刻度以上のトリガーのみを返します。
evaltype integer タグの評価方法を指定します。

指定可能な値:
0 - (default) And/Or;
2 - Or.
tags array 指定したタグを持つトリガーのみを返します。
形式: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]
空の配列を指定すると、すべてのトリガーを返します。

指定可能なoperatorの値:
0 - (default) Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.
expandComment flag トリガーの説明内のマクロを展開します。
expandDescription flag トリガー名内のマクロを展開します。
expandExpression flag トリガー式内の関数とマクロを展開します。
selectHostGroups query トリガーが属するホストグループをhostgroupsプロパティで返します。
selectHosts query トリガーが属するホストをhostsプロパティで返します。
selectItems query トリガーに含まれるアイテムをitemsプロパティで返します。
selectFunctions query トリガーで使用される関数をfunctionsプロパティで返します。

関数オブジェクトは、トリガー式で使用される関数を表し、次のプロパティを持ちます:
functionid - (ID) 関数のID;
itemid - (ID) 関数で使用されるアイテムのID;
function - (string) 関数名;
parameter - (string) 関数に渡されるパラメータ。クエリパラメータは、返される文字列内で$記号に置き換えられます。
selectDependencies query トリガーが依存するトリガーをdependenciesプロパティで返します。
selectDiscoveryData query トリガー発見オブジェクトのデータを含むdiscoveryDataプロパティを返します。トリガー発見オブジェクトは、発見されたトリガーと、その元になったトリガープロトタイプを関連付けます。

次のプロパティを持ちます:
parent_triggerid - (ID) トリガーが作成された元のトリガープロトタイプのID;
status - (int) トリガー発見ステータス:
0 - (default) トリガーは発見済み,
1 - トリガーはもはや発見されていない;
ts_delete - (timestamp) もはや発見されていないトリガーが削除される時刻;
ts_disable - (timestamp) もはや発見されていないトリガーが無効化される時刻;
disable_source - (int) トリガーがLLDルールによって無効化されたか、手動で無効化されたかを示す指標:
0 - (default) 自動的に無効化,
1 - LLDルールによって無効化。
selectDiscoveryRule query トリガーを作成した低レベルディスカバリルールdiscoveryRuleプロパティで返します。
selectLastEvent query 最後の重要なトリガーイベントをlastEventプロパティで返します。
selectTags query トリガーのタグをtagsプロパティで返します。
selectTemplateGroups query トリガーが属するテンプレートグループをtemplategroupsプロパティで返します。
filter object 指定したフィルターに完全一致する結果のみを返します。

キーがプロパティ名、値が照合対象の単一値または値の配列であるオブジェクトを受け付けます。

text data type のプロパティはサポートされません。

追加で次のプロパティをサポートします:
host - トリガーが属するホストの技術名;
hostid - トリガーが属するホストのID。
limitSelects integer サブセレクトで返されるレコード数を制限します。

次のサブセレクトに適用されます:
selectHosts - 結果はhostでソートされます。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: triggerid, description, status, priority, lastchange, hostname
countOutput boolean これらのパラメータはreference commentaryで説明されています。
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query triggerDiscoveryプロパティでトリガー発見オブジェクトを返します。トリガー発見オブジェクトは、トリガーと、その元になったトリガープロトタイプを関連付けます。

このクエリは非推奨です。代わりにselectDiscoveryDataを使用してください。

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメーターが使用されている場合、取得したオブジェクトの数

トリガーIDによるデータの取得

トリガー "14062" で使用されているすべてのデータと関数を取得します。

Request:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "triggerids": "14062",
        "output": "extend",
        "selectFunctions": "extend"
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "14062",
            "expression": "{13513}<10m",
            "description": "{HOST.NAME} has been restarted (uptime < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "The host uptime is less than 10 minutes",
            "error": "",
            "templateid": "10016",
            "type": "0",
            "state": "0",
            "flags": "0",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "event_name": "",
            "uuid": "",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13513",
                    "itemid": "24350",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

障害状態のトリガーの取得

障害状態にあるすべてのトリガーの ID、名前、深刻度を取得し、深刻度の降順で並べ替えます。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description",
            "priority"
        ],
        "filter": {
            "value": 1
        },
        "sortfield": "priority",
        "sortorder": "DESC"
    },
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13907",
            "description": "Zabbix self-monitoring processes < 100% busy",
            "priority": "4"
        },
        {
            "triggerid": "13824",
            "description": "Zabbix discoverer processes more than 75% busy",
            "priority": "3"
        }
    ],
    "id": 1
}

タグ付きの特定のトリガーを取得する

タグ付きの特定のトリガーを取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17578"
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17370",
            "description": "Service status",
            "tags": [
                {
                    "tag": "service",
                    "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                },
                {
                    "tag": "error",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

関連項目

ソース

CTrigger::get() in ui/include/classes/api/services/CTrigger.php.