Sidebar
Table of Contents
检索触发器原型
描述
integer/array triggerprototype.get(object parameters)
此方法允许根据指定的参数检索触发器原型.
此方法适用于任何类型的用户， 调用方法的权限可以在用户角色设置中进行撤销，请参阅 用户角色了解更多信息.
参数
(object) 定义需要输出的参数.
该方法支持以下参数.
| 参数 | 类型 | 描述 |
|---|---|---|
| active | flag | 仅返回属于被监控主机的已启用触发器原型. |
| discoveryids | string/array | 仅返回属于指定低级别发现规则的触发器原型. |
| functions | string/array | 仅返回使用指定函数的触发器. 有关支持的功能列表，请参阅支持的触发功能 页面. |
| group | string | 仅返回属于指定名称的主机组中属于主机的触发器原型. |
| groupids | string/array | 仅返回来自指定主机组ID中属于主机的触发器原型. |
| host | string | 仅返回属于指名称的主机的触发器原型. |
| hostids | string/array | 仅返回属于指定主机id的触发器原型. |
| inherited | boolean | 如果设置为true，仅返回从模板继承的触发器原型. |
| maintenance | boolean | 如果设置为true，仅返回属于在维护中主机的已启用触发器原型，. |
| min_severity | integer | 仅返回严重性大于或等于指定严重性的触发器原型. |
| monitored | flag | 仅返回属于被监控主机且仅包含已启用监控项的已启用触发器原型. |
| templated | boolean | 如果设置为 true 仅返回属于模板的触发器原型. |
| templateids | string/array | 仅返回属于指定模板ID的触发器原型. |
| triggerids | string/array | 仅返回属于给定ID的触发器原型. |
| expandExpression | flag | 展开在触发器原型表达式中的函数和宏. |
| selectDependencies | query | 在 dependencies 属性中返回触发器原型和触发器原型所依赖的触发器. |
| selectDiscoveryRule | query | 返回触发器原型所属的 低级别发现规则 . |
| selectFunctions | query | 在 functions 属性中返回触发器原型中使用的函数.函数对象表示触发器表达式中使用的函数，并具有以下属性: functionid - (string) 函数的ID;itemid - (string) 在函数中使用的监控项ID;function - (string) 函数名称;parameter - (string) 传递给函数的参数，查询参数被返回字符串中的 $ 符号替换. |
| selectGroups | query | 在 组 属性中返回触发器原型所属的主机组. |
| selectHosts | query | 在 主机 属性中返回触发器原型所属的主机. |
| selectItems | query | 返回项目和项目原型使用 监控项 属性中的触发器原型. |
| selectTags | query | 返回 标签 中的触发器原型标签. |
| filter | object | 仅返回与指定筛选完全匹配的结果. 接受一个数组，其中键是属性名称，值可以是单个值，也可以是要匹配的值数组. 支持额外的筛选: host - 触发器原型所属主机的正式名称;hostid - 触发器原型所属主机的ID. |
| limitSelects | integer | 限制子查询返回的记录数量. 适用于以下子查询: 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参数，则检索对象的计数.
示例
从低级别发现规则中检索触发器原型
从低级别发现规则中检索所有的触发器原型和相关函数.
请求:
{
"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
}根据标签检索特定的触发器原型
请求:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": [
"triggerid",
"description"
]
"selectTags": "extend",
"triggerids": [
"17373"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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
}另见
源码
CTriggerPrototype::get() in ui/include/classes/api/services/CTriggerPrototype.php.