Documentation
Table of Contents
discoveryrule.create
描述
object discoveryrule.create(object/array lldRules)此方法允许create新的LLD规则。
此方法仅对Admin和Super admin用户类型可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见User roles。
参数
(object/array) 用于创建LLD规则。
除了lld规则之外， 该方法还接受以下参数。
| 参数 | 数据类型 | 说明 |
|---|---|---|
| filter | object | LLD规则的lld-规则过滤器。 |
| preprocessing | object/array | lld-规则预处理选项。 |
| lld_macro_paths | object/array | LLD规则lld-宏路径选项。 |
| overrides | object/array | lld-规则覆盖选项。 |
返回值
(object) 返回一个 object，其中包含在 itemids 属性下列出的已创建 LLD 规则的 ID。返回的 ID 顺序与传入的 LLD 规则顺序一致。
示例
创建 LLD 规则
创建一个 Zabbix agent LLD 规则以发现已挂载的 file 系统。 发现的 监控项 将每 30 秒更新一次。
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "Mounted filesystem discovery", "key_": "vfs.fs.discovery", "hostid": "10197", "type": 0, "interfaceid": "112", "delay": "30s" }, "id": 1 }响应：
使用过滤器
创建一个LLD规则，并设置一组条件来过滤结果。 这些条件将使用逻辑“与”运算符进行组合。
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "Filtered LLD rule", "key_": "lld", "hostid": "10116", "type": 0, "interfaceid": "13", "delay": "30s", "filter": { "evaltype": 1, "conditions": [ { "macro": "{#MACRO1}", "value": "@regex1" }, { "macro": "{#MACRO2}", "value": "@regex2", "operator": "9" }, { "macro": "{#MACRO3}", "value": "", "operator": "12" }, { "macro": "{#MACRO4}", "value": "", "operator": "13" } ] } }, "id": 1 }响应：
创建带宏路径的LLD规则
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "LLD rule with LLD macro paths", "key_": "lld", "hostid": "10116", "type": 0, "interfaceid": "13", "delay": "30s", "lld_macro_paths": [ { "lld_macro": "{#MACRO1}", "path": "$.path.1" }, { "lld_macro": "{#MACRO2}", "path": "$.path.2" } ] }, "id": 1 }响应：
使用自定义表达式过滤器
创建一个带有过滤器的LLD规则，该过滤器将使用自定义表达式来评估条件。此LLD规则必须仅发现objects满足以下条件：其"{#MACRO1}"宏值同时匹配正则表达式"regex1"和"regex2"，且"{#MACRO2}"的值匹配"regex3"或"regex4"。公式ID"A"、"B"、"C"和"D"为任意选定。
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "Filtered LLD rule", "key_": "lld", "hostid": "10116", "type": 0, "interfaceid": "13", "delay": "30s", "filter": { "evaltype": 3, "formula": "(A and B) and (C or D)", "conditions": [ { "macro": "{#MACRO1}", "value": "@regex1", "formulaid": "A" }, { "macro": "{#MACRO1}", "value": "@regex2", "formulaid": "B" }, { "macro": "{#MACRO2}", "value": "@regex3", "formulaid": "C" }, { "macro": "{#MACRO2}", "value": "@regex4", "formulaid": "D" } ] } }, "id": 1 }响应:
使用自定义查询字段和请求头
创建带有自定义query字段和标头的LLD规则。
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "hostid": "10257", "interfaceid": "5", "type": 19, "name": "API HTTP agent", "key_": "api_discovery_rule", "delay": "5s", "url": "http://127.0.0.1?discoverer.php", "query_fields": [ { "name": "mode", "value": "json" }, { "name": "elements", "value": "2" } ], "headers": [ { "name": "X-Type", "value": "api" }, { "name": "Authorization", "value": "Bearer mF_A.B5f-2.1JcM" } ], "allow_traps": 1, "trapper_hosts": "127.0.0.1" }, "id": 1 }响应：
创建带预处理的LLD规则
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "Discovery rule with preprocessing", "key_": "lld.with.preprocessing", "hostid": "10001", "ruleid": "27665", "type": 0, "delay": "60s", "interfaceid": "1155", "preprocessing": [ { "type": 20, "params": "20", "error_handler": 0, "error_handler_params": "" } ] }, "id": 1 }响应：
创建带覆盖的LLD规则
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "Discover database host", "key_": "lld.with.overrides", "hostid": "10001", "type": 0, "delay": "60s", "interfaceid": "1155", "overrides": [ { "name": "Discover MySQL host", "step": "1", "stop": "1", "filter": { "evaltype": "2", "conditions": [ { "macro": "{#UNIT.NAME}", "operator": "8", "value": "^mysqld\\.service$" }, { "macro": "{#UNIT.NAME}", "operator": "8", "value": "^mariadb\\.service$" } ] }, "operations": [ { "operationobject": "3", "operator": "2", "value": "Database host", "opstatus": { "status": "0" }, "optemplate": [ { "templateid": "10170" } ], "optag": [ { "tag": "database", "value": "mysql" } ] } ] }, { "name": "Discover PostgreSQL host", "step": "2", "stop": "1", "filter": { "evaltype": "0", "conditions": [ { "macro": "{#UNIT.NAME}", "operator": "8", "value": "^postgresql\\.service$" } ] }, "operations": [ { "operationobject": "3", "operator": "2", "value": "Database host", "opstatus": { "status": "0" }, "optemplate": [ { "templateid": "10263" } ], "optag": [ { "tag": "database", "value": "postgresql" } ] } ] } ] }, "id": 1 }响应：
创建脚本LLD规则
使用脚本LLD规则创建一个简单的数据收集。
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "Script example", "key_": "custom.script.lldrule", "hostid": "12345", "type": 21, "params": "var request = new HttpRequest();\nreturn request.post(\"https://postman-echo.com/post\", JSON.parse(value));", "parameters": [{ "name": "host", "value": "{HOST.CONN}" }], "timeout": "6s", "delay": "30s" }, "id": 1 }响应：
创建LLD规则，指定禁用时间段且不删除
创建一个LLD规则，并自定义时间周期用于在实体不再被发现后将其禁用，同时设置为永不删除。
执行请求:
{ "jsonrpc": "2.0", "method": "discoveryrule.create", "params": { "name": "lld disable after 1h", "key_": "lld.disable", "hostid": "10001", "type": 2, "lifetime_type": 1, "enabled_lifetime_type": 0, "enabled_lifetime": "1h" }, "id": 1 }响应：
另请参阅
来源
CDiscoveryRule::create() 在 ui/include/classes/api/services/CDiscoveryRule.php 中。