Documentation
alert.get
描述
integer/array alert.get(object parameters)
该方法允许根据给定的参数检索告警。
此方法可供任何类型的用户使用。可以在用户角色设置中撤销调用此方法的权限。更多信息请参见 User roles。
参数
(object) 参数定义了期望的输出。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| alertids | ID/array | 仅返回具有指定ID的告警。 |
| actionids | ID/array | 仅返回由指定动作生成的告警。 |
| eventids | ID/array | 仅返回由指定事件生成的告警。 |
| groupids | ID/array | 仅返回由指定主机组中的objects生成的告警。 |
| hostids | ID/array | 仅返回由指定主机中的objects生成的告警。 |
| mediatypeids | ID/array | 仅返回使用了指定媒介类型的邮件告警。 |
| objectids | ID/array | 仅返回由指定objects生成的告警。 |
| userids | ID/array | 仅返回发送给指定用户的邮件告警。 |
| eventobject | integer | 仅返回与指定类型objects相关的事件生成的告警。 支持的object类型列表，请参见事件 object。默认值：0 - 触发器。 |
| eventsource | integer | 仅返回指定类型的事件生成的告警。 支持的事件类型列表，请参见事件 source。默认值：0 - 触发器事件。 |
| time_from | timestamp | 仅返回在指定时间之后生成的告警。 |
| time_till | timestamp | 仅返回在指定时间之前生成的告警。 |
| selectHosts | query | 返回一个hosts属性，包含触发动作操作的主机数据。 |
| selectMediatypes | query | 返回一个mediatypes属性，包含用于邮件告警的媒介类型的array。关于基于用户类型的限制，请参见 mediatype.get。 |
| selectUsers | query | 返回一个users属性，包含邮件发送目标用户的array。关于基于用户类型的限制，请参见 user.get。 |
| sortfield | string/array | 按照指定属性对结果进行排序。 可能的值： alertid、clock、eventid、mediatypeid、sendto、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 |
在 Zabbix 7.0.9 中，Admin 和 User 类型的用户只能检索关于其自身用户的“消息”（0）类型告警数据。
返回值
(integer/array) 返回以下之一：
- array 的 objects；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
按动作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: Zabbix agent on Linux server is unreachable for 5 minutes: ",
"message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
"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 中。