triggerprototype.get
説明
integer/array triggerprototype.get(object parameters)
このメソッドを使用すると、指定したパラメータに従ってトリガープロトタイプを取得できます。
このメソッドは、あらゆる種類のユーザーが利用できます。 このメソッドの呼び出し権限は、ユーザーロール設定で取り消すことができます。 詳細は User roles を参照してください。
パラメータ
(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()。