Documentation
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；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
检索关联
检索所有已配置的相关性及其相关条件和操作。该过滤器使用“与/或”评估类型， 因此 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 中。