获取
描述
integer/array alert.get(object parameters)
该方法允许根据给定的参数检索告警。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用此方法的权限。更多信息请参见用户角色。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 说明 |
|---|---|---|
| alertids | ID/array | 仅返回具有给定 ID 的告警。 |
| actionids | ID/array | 仅返回由给定动作生成的告警。 |
| eventids | ID/array | 仅返回由给定事件生成的告警。 |
| groupids | ID/array | 仅返回由给定主机组中的对象生成的告警。 |
| hostids | ID/array | 仅返回由给定主机中的对象生成的告警。 |
| mediatypeids | ID/array | 仅返回使用给定媒介类型的消息告警。 |
| objectids | ID/array | 仅返回由给定对象生成的告警。 |
| userids | ID/array | 仅返回发送给给定用户的消息告警。 |
| eventobject | integer | 仅返回由与给定类型对象相关的事件生成的告警。 支持的对象类型列表请参见 event object。默认值：0 - 触发器。 |
| eventsource | integer | 仅返回由给定类型事件生成的告警。 支持的事件类型列表请参见 event source。默认值：0 - 触发器事件。 |
| time_from | timestamp | 仅返回在给定时间之后生成的告警。 |
| time_till | timestamp | 仅返回在给定时间之前生成的告警。 |
| selectHosts | query | 返回 hosts 属性，其中包含触发该动作操作的主机数据。 |
| selectMediatypes | query | 返回 mediatypes 属性，其中包含用于该消息告警的媒介类型数组。有关基于用户类型的限制，请参见 mediatype.get。 |
| selectUsers | query | 返回 users 属性，其中包含该消息所发送给的用户数组。有关基于用户类型的限制，请参见 user.get。 |
| sortfield | string/array | 按给定属性对结果进行排序。 可选值： alertid、clock、eventid、mediatypeid、sendto、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参数，则返回检索到的对象的数量。
示例
按动作 ID 检索告警
检索由动作“3”生成的所有告警。
请求：
{
"jsonrpc": "2.0",
"method": "alert.get",
"params": {
"output": "extend",
"actionids": "3"
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"alertid": "1",
"actionid": "3",
"eventid": "21243",
"userid": "1",
"clock": "1362128008",
"mediatypeid": "1",
"sendto": "[email protected]",
"subject": "PROBLEM: Linux 服务器上的 Zabbix agent 已有 5 分钟无法访问：",
"message": "触发器：Linux 服务器上的 Zabbix agent 已有 5 分钟无法访问：\n触发器状态：PROBLEM\n触发器严重性：未分类",
"status": "0",
"retries": "3",
"error": "",
"esc_step": "1",
"alerttype": "0",
"p_eventid": "0",
"acknowledgeid": "0"
}
],
"id": 1
}另请参阅
源码位置
CAlert::get() 在 ui/include/classes/api/services/CAlert.php 文件中。