triggerprototype.get

説明

integer/array triggerprototype.get(object parameters)

このメソッドを使用すると、指定されたパラメーターに従ってトリガープロトタイプを取得できます。

このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。

パラメータ

(object) 目的の出力を定義するパラメーター

このメソッドは、次のパラメーターをサポートしています。

パラメータ	タイプ	説明
active	flag	監視対象ホストに属する有効なトリガープロトタイプのみを返します。
discoveryids	string/array	指定された LLD ルールに属するトリガープロトタイプのみを返します。
functions	string/array	指定された関数を使用するトリガーのみを返します。サポートされている関数のリストについては、サポートされているトリガー関数ページを参照してください。
group	string	指定された名前のホストグループのホストに属するトリガープロトタイプのみを返します。
groupids	string/array	指定されたホストグループのホストに属するトリガープロトタイプのみを返します。
host	string	指定された名前のホストに属するトリガープロトタイプのみを返します。
hostids	string/array	指定されたホストに属するトリガープロトタイプのみを返します。
inherited	boolean	"true"に設定すると、テンプレートから継承されたトリガープロトタイプのみが返されます。
maintenance	boolean	"true"に設定すると、メンテナンス中のホストに属する有効なトリガープロトタイプのみが返されます。
min_severity	integer	指定された深刻度以上の深刻度を持つトリガープロトタイプのみを返します。
monitored	flag	監視対象ホストに属し、有効なアイテムのみを含む有効なトリガープロトタイプのみを返します。
templated	boolean	"true"に設定すると、テンプレートに属するトリガープロトタイプのみが返されます。
templateids	string/array	指定されたテンプレートに属するトリガープロトタイプのみを返します。
triggerids	string/array	指定された ID を持つトリガープロトタイプのみを返します。
expandExpression	flag	トリガー式で関数とマクロを展開します。
selectDependencies	query	トリガープロトタイプと、トリガープロトタイプが依存するトリガーを `dependencies` プロパティで返します。
selectDiscoveryRule	query	トリガープロトタイプが属する LLD ルールを返します。
selectFunctions	query	`functions` プロパティのトリガープロトタイプで使用される関数を返します。関数オブジェクトは、トリガー式で使用される関数を表し、次のプロパティがあります: `functionid` - (string) ID 関数の; `itemid` - (string) 関数で使用されるアイテムの ID; `function` - (string) 関数の名前; `parameter` - * (文字列)* 関数に渡されるパラメーター。クエリパラメータは、返された文字列で `$` 記号に置き換えられます。
selectGroups	query	groups プロパティで、トリガープロトタイプが属するホストグループを返します。
selectHosts	query	hosts プロパティでトリガープロトタイプが属するホストを返します。
selectItems	query	items プロパティでトリガープロトタイプを使用したアイテムとアイテムプロトタイプを返します。
selectTags	query	tags プロパティでトリガープロトタイプタグを返します。
filter	object	指定されたフィルタに正確に一致する結果のみを返します。配列を受け入れます。キーはプロパティ名で、値は単一の値または照合する値の配列です。 <br >追加のフィルターをサポート: `host` - トリガープロトタイプが属するホストの技術名; `hostid` - トリガープロトタイプが属するホストの ID
limitSelects	integer	サブselects によって返されるレコードの数を制限します。次のサブselects に適用されます: `selectHosts` - 結果は `host` でソートされます。
sortfield	string/array	指定されたプロパティで結果を並べ替えます。使用可能な値: `triggerid`,`description`,`status`,`priority`
countOutput	boolean	すべての`get`メソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。
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"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

レスポンス :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Free inodes is less than 20% on volume {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "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",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "triggerid": "13266",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

タグで特定のトリガープロトタイプを取得