triggerprototype.get
説明
integer/array triggerprototype.get(object parameters)
このメソッドは、指定されたパラメータに従ってトリガープロトタイプを取得することができます。
このメソッドは、すべてのタイプのユーザーが利用できます。 このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。 詳細はユーザーロールを参照してください。
パラメーター
(object) 望ましい出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | 型 | 説明 |
|---|---|---|
| active | flag | 監視対象ホストに属する有効なトリガープロトタイプのみを返します。 |
| discoveryids | ID/array | 指定したLLDルールに属するトリガープロトタイプのみを返します。 |
| functions | string/array | 指定した関数を使用するトリガーのみを返します。 サポートされている関数の一覧はサポートされている関数ページを参照してください。 |
| 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 - (デフォルト) トリガープロトタイプは検出済み, 1 - トリガープロトタイプはもはや検出されていない; ts_delete - (timestamp) もはや検出されていないトリガープロトタイプが削除される時刻;ts_disable - (timestamp) もはや検出されていないトリガープロトタイプが無効化される時刻;disable_source - (int) トリガープロトタイプがLLDルールによって無効化されたか手動で無効化されたかの指標:0 - (デフォルト) 自動的に無効化, 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データ型のプロパティはサポートされません。追加プロパティをサポートします: host - トリガープロトタイプが属するホストの技術名;hostid - トリガープロトタイプが属するホストのID。 |
| limitSelects | integer | サブセレクトで返されるレコード数を制限します。 以下のサブセレクトに適用されます: selectHosts - 結果はhostでソートされます。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 指定可能な値: triggerid, description, status, priority, discovered. |
| countOutput | boolean | これらのパラメーターはリファレンス解説で説明されています。 |
| 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()。