triggerprototype.get
説明
integer/array triggerprototype.get(object parameters)
このメソッドは、指定したパラメーターに応じたトリガーのプロトタイプを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) 必要な出力を定義するパラメータ。
このメソッドは以下のパラメータをサポートしています。
| Parameter | Type | Description |
|---|---|---|
| active | flag | 監視中のホストに属する有効なトリガープロトタイプのみを返します。 |
| discoveryids | ID/array | 指定されたLLDルールに属するトリガープロトタイプのみを返します。 |
| functions | string/array | 指定された関数を使用するトリガーのみを返します。 サポートされている関数の一覧は、Supported functionsページを参照してください。 |
| group | string | 指定された名前のホストグループまたはテンプレートグループに属するホストまたはテンプレートに属するトリガープロトタイプのみを返します。 |
| groupids | ID/array | 指定されたホストグループまたはテンプレートグループに属するホストまたはテンプレートに属するトリガープロトタイプのみを返します。 |
| host | string | 指定された名前のホストに属するトリガープロトタイプのみを返します。 |
| hostids | ID/array | 指定されたホストに属するトリガープロトタイプのみを返します。 |
| inherited | boolean | true に設定した場合、テンプレートから継承されたトリガープロトタイプのみを返します。 |
| maintenance | boolean | true に設定した場合、メンテナンス中のホストに属する有効なトリガープロトタイプのみを返します。 |
| min_severity | integer | 指定された深刻度以上のトリガープロトタイプのみを返します。 |
| monitored | flag | 監視中のホストに属し、有効なアイテムのみを含む有効なトリガープロトタイプのみを返します。 |
| templated | boolean | true に設定した場合、テンプレートに属するトリガープロトタイプのみを返します。 |
| templateids | ID/array | 指定されたテンプレートに属するトリガープロトタイプのみを返します。 |
| triggerids | ID/array | 指定されたIDを持つトリガープロトタイプのみを返します。 |
| expandExpression | flag | トリガー条件式内の関数およびマクロを展開します。 |
| selectDependencies | query | トリガープロトタイプが依存しているトリガープロトタイプおよびトリガーを、dependencies プロパティで返します。 |
| selectDiscoveryRule | query | トリガープロトタイプが属するLLDルールを、discoveryRule プロパティで返します。 |
| selectFunctions | query | トリガープロトタイプで使用されている関数を、functions プロパティで返します。関数オブジェクトはトリガー条件式で使用される関数を表し、以下のプロパティを持ちます。 functionid - (ID) 関数のID。itemid - (ID) 関数で使用されるアイテムのID。function - (string) 関数名。parameter - (string) 関数に渡されるパラメータ。クエリパラメータは、返される文字列では $ 記号に置き換えられます。 |
| selectHostGroups | query | トリガープロトタイプが属するホストグループを、hostgroups プロパティで返します。 |
| selectHosts | query | トリガープロトタイプが属するホストを、hosts プロパティで返します。 |
| selectItems | query | トリガープロトタイプで使用されるアイテムおよびアイテムプロトタイプを、items プロパティで返します。 |
| 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, discovered. |
| 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 | |
| selectGroups (deprecated) |
query | このパラメータは非推奨です。代わりに selectHostGroups または selectTemplateGroups を使用してください。トリガープロトタイプが属するホストグループおよびテンプレートグループを、 groups プロパティで返します。 |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
LLDルールからトリガープロトタイプを取得
LLDルールから、すべてのトリガープロトタイプとその関数を取得します。
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": "extend",
"selectFunctions": "extend",
"discoveryids": "22450"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "13272",
"expression": "{12598}<20",
"description": "ボリューム {#FSNAME} の空きinode数が20%未満です",
"url": "",
"status": "0",
"value": "0",
"priority": "2",
"lastchange": "0",
"comments": "",
"error": "",
"templateid": "0",
"type": "0",
"state": "0",
"flags": "2",
"recovery_mode": "0",
"recovery_expression": "",
"correlation_mode": "0",
"correlation_tag": "",
"manual_close": "0",
"opdata": "",
"discover": "0",
"event_name": "",
"uuid": "6ce467d05e8745409a177799bed34bb3",
"url_name": "",
"functions": [
{
"functionid": "12598",
"itemid": "22454",
"parameter": "$",
"function": "last"
}
]
},
{
"triggerid": "13266",
"expression": "{13500}<20",
"description": "ボリューム {#FSNAME} の空きディスク容量が20%未満です",
"url": "",
"status": "0",
"value": "0",
"priority": "2",
"lastchange": "0",
"comments": "",
"error": "",
"templateid": "0",
"type": "0",
"state": "0",
"flags": "2",
"recovery_mode": "0",
"recovery_expression": "",
"correlation_mode": "0",
"correlation_tag": "",
"manual_close": "0",
"opdata": "",
"discover": "0",
"event_name": "",
"uuid": "74a1fc62bfe24b7eabe4e244c70dc384",
"url_name": "",
"functions": [
{
"functionid": "13500",
"itemid": "22686",
"parameter": "$",
"function": "last"
}
]
}
],
"id": 1
}タグで特定のトリガープロトタイプを取得
リクエスト :
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17373"
]
},
"id": 1
}レスポンス :
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "17373",
"description": "Free disk space is less than 20% on volume {#FSNAME}",
"tags": [
{
"tag": "volume",
"value": "{#FSNAME}"
},
{
"tag": "type",
"value": "{#FSTYPE}"
}
]
}
],
"id": 1
}関連項目
ソース
CTriggerPrototype::get() in ui/include/classes/api/services/CTriggerPrototype.php.