discoveryrule.update

描述

object discoveryrule.update(object/array lldRules)

此方法用于 update 现有的 LLD 规则。

此方法仅适用于 管理员超级管理员 用户类型。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见 User roles

参数

(object/array) 要更新的LLD规则属性。

每个LLD规则必须定义 itemid 属性,所有其他属性都是可选的。只有传递的属性会被更新,其他属性将保持不变。

除了 lld规则 之外,该方法还接受以下参数。

参数 数据类型 描述
filter object 用于替换现有过滤器的 lld-规则过滤器
preprocessing object/array 用于替换现有预处理选项的 lld-规则预处理 选项。

参数行为
- 继承的 objects 为只读
lld_macro_paths object/array LLD规则 lld-宏路径 选项,用于替换现有的lld_macro_path选项。

参数行为
- 继承的 objects 为只读
overrides object/array 用于替换现有覆盖选项的 lld-规则覆盖 选项。

参数行为
- 继承的 objects 为只读

返回值

(object) 返回一个 object,其中包含更新的 LLD 规则的 ID, 这些 ID 位于 itemids 属性下。

示例

向 LLD 规则添加过滤器

添加过滤器,使{#FSTYPE}宏的内容能够匹配@用于发现的文件系统正则表达式。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "discoveryrule.update",
           "params": {
               "itemid": "22450",
               "filter": {
                   "evaltype": 1,
                   "conditions": [
                       {
                           "macro": "{#FSTYPE}",
                           "value": "@File systems for discovery"
                       }
                   ]
               }
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "itemids": [
                   "22450"
               ]
           },
           "id": 1
       }

添加 LLD 宏路径

执行请求:

{
           "jsonrpc": "2.0",
           "method": "discoveryrule.update",
           "params": {
               "itemid": "22450",
               "lld_macro_paths": [
                   {
                       "lld_macro": "{#MACRO1}",
                       "path": "$.json.path"
                   }
               ]
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "itemids": [
                   "22450"
               ]
           },
           "id": 1
       }

禁用陷阱

禁用发现规则的LLD探测。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "discoveryrule.update",
           "params": {
               "itemid": "28336",
               "allow_traps": 0
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "itemids": [
                   "28336"
               ]
           },
           "id": 1
       }

更新LLD规则预处理选项

使用预处理规则“JSONPath”更新LLD规则。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "discoveryrule.update",
           "params": {
               "itemid": "44211",
               "preprocessing": [
                   {
                       "type": 12,
                       "params": "$.path.to.json",
                       "error_handler": 2,
                       "error_handler_params": "5"
                   }
               ]
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "itemids": [
                   "44211"
               ]
           },
           "id": 1
       }

更新LLD规则脚本

使用不同的脚本更新LLD规则脚本,并移除先前脚本使用的不必要的参数。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "discoveryrule.update",
           "params": {
               "itemid": "23865",
               "parameters": [],
               "script": "Zabbix.log(3, 'Log test');\nreturn 1;"
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "itemids": [
                   "23865"
               ]
           },
           "id": 1
       }

更新LLD规则生命周期

更新LLD规则,在实体不再被发现后将其禁用12小时,并在7天后将其delete。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "discoveryrule.update",
           "params": {
               "itemid": "46864",
               "lifetime_type": 0, 
               "lifetime": "7d",
               "enabled_lifetime_type": 0,
               "enabled_lifetime": "12h"
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "itemids": [
                   "46864"
               ]
           },
           "id": 1
       }

来源

CDiscoveryRule::update() 函数位于 ui/include/classes/api/services/CDiscoveryRule.php 文件中。