triggerprototype.get
説明
integer/array triggerprototype.get(object parameters)
このメソッドを使用すると、指定したパラメータに従ってトリガープロトタイプを取得できます。
このメソッドは、あらゆる種類のユーザーが利用できます。メソッドの呼び出し権限は、ユーザーのロール設定で取り消すことができます。 詳細は User roles を参照してください。
パラメーター
(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 プロパティで、トリガープロトタイプが属するホストを返します。 |
| 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": "ボリューム {#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
}関連項目
ソース
ui/include/classes/api/services/CTriggerPrototype.php の CTriggerPrototype::get()。