Documentation
Table of Contents
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 ルールから取得します。
Request:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": "extend",
"selectFunctions": "extend",
"discoveryids": "22450"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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
}タグを使用して特定のトリガー プロトタイプを取得する
Request:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": [
"triggerid",
"description"
]
"selectTags": "extend",
"triggerids": [
"17373"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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
}参照
ソース
CTriggerPrototype::get() in ui/include/classes/api/services/CTriggerPrototype.php.