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 プロパティで返します。 |
| 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 | トリガープロトタイプが属するLLDルールを discoveryRule プロパティで返します。 |
| selectDiscoveryRulePrototype | query | トリガープロトタイプが属する親LLDルールプロトタイプを含む discoveryRulePrototype プロパティを返します。 |
| selectFunctions | query | トリガープロトタイプで使用されている関数を functions プロパティで返します。関数オブジェクトはトリガー条件式で使用される関数を表し、以下のプロパティを持ちます。 functionid - (ID) 関数のID。itemid - (ID) 関数で使用されるアイテムのID。function - (string) 関数名。parameter - (string) 関数に渡されるパラメータ。クエリパラメータは、返される文字列内で $ 記号に置き換えられます。 |
| selectHostGroups | query | トリガープロトタイプが属するホストグループを hostgroups プロパティで返します。 |
| selectHosts | query | トリガープロトタイプが属するホストを hosts プロパティで返します。 |
| selectInheritedTags | query | テンプレート、リンクされたテンプレート、ホストから継承されたタグ、およびトリガー条件式またはリカバリ条件式で参照されるアイテムプロトタイプから継承されたタグを含む inheritedTags プロパティを返します。 |
| 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 |
戻り値
(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": "Free inodes is less than 20% on volume {#FSNAME}",
"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",
"triggerid": "13272",
"parameter": "$",
"function": "last"
}
]
},
{
"triggerid": "13266",
"expression": "{13500}<20",
"description": "Free disk space is less than 20% on volume {#FSNAME}",
"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",
"triggerid": "13266",
"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
}関連項目
ソース
ui/include/classes/api/services/CTriggerPrototype.php の CTriggerPrototype::get()。