correlation.get
描述
integer/array correlation.get(object parameters)
该方法允许根据给定参数检索关联关系。
该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles。
参数
(object) 定义所需输出的参数.
该方法支持以下参数.
| 参数 | 数据类型 | 描述 |
|---|---|---|
| correlationids | ID/array | 仅返回具有给定ID的关联. |
| selectFilter | query | 返回一个包含关联条件的filter属性. |
| selectOperations | query | 返回一个包含关联操作的operations属性. |
| sortfield | string/array | 按给定属性排序结果. 可能值: correlationid, name, status. |
| countOutput | boolean | 这些参数在通用get方法参数中有描述. |
| 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) 返回以下两种结果之一:
- 一个包含array的objects数组
- 检索到的objects数量（当使用了
countOutput参数时）
示例
检索关联
获取所有已配置的关联规则及其关联条件与操作。过滤器采用"与/或"评估类型， 因此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
}另请参阅
来源
CCorrelation::get() 位于 ui/include/classes/api/services/CCorrelation.php 文件中.