获取

描述

integer/array correlation.get(object parameters)

该方法允许根据给定参数检索关联关系。

任何类型的用户都可以使用此方法。调用该方法的权限可在用户角色设置中撤销。更多信息请参见用户角色。

参数

(object) 用于定义所需输出的参数。

该方法支持以下参数。

参数 类型 描述
correlationids ID/array 仅返回具有给定 ID 的事件关联。
selectFilter query 返回一个包含事件关联条件的 filter 属性。
selectOperations query 返回一个包含事件关联操作的 operations 属性。
sortfield string/array 按给定属性对结果进行排序。

可选值：correlationid、name、status。
countOutput boolean 这些参数在参考注释中进行了说明。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回其中之一：

  • 一个对象数组；
  • 如果使用了 countOutput 参数，将返回获取对象的数量。

示例

检索关联关系

检索所有已配置的关联关系及其关联条件和操作。该过滤器使用“and/or”求值类型，因此 formula 属性为空，eval_formula 会自动生成。

请求:

{
    "jsonrpc": "2.0",
    "method": "correlation.get",
    "params": {
        "output": "extend",
        "selectOperations": "extend",
        "selectFilter": "extend"
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": [
        {
            "correlationid": "1",
            "name": "Correlation 1",
            "description": "",
            "status": "0",
            "filter": {
                "evaltype": "0",
                "formula": "",
                "conditions": [
                    {
                        "type": "3",
                        "oldtag": "error",
                        "newtag": "ok",
                        "formulaid": "A"
                    }
                ],
                "eval_formula": "A"
            },
            "operations": [
                {
                    "type": "0"
                }
            ]
        }
    ],
    "id": 1
}

另请参阅

来源

ui/include/classes/api/services/CCorrelation.php 中的 CCorrelation::get()。