integer/array alert.get(object parameters)
该方法允许根据给定的参数检索告警。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用此方法的权限。更多信息请参见用户角色。
(object)
定义所需输出的参数。
该方法支持以下参数。
参数 | 类型 | 描述 |
---|---|---|
alertids | ID/数组 | 仅返回具有给定ID的告警。 |
actionids | ID/数组 | 仅返回由给定动作生成的告警。 |
eventids | ID/数组 | 仅返回由给定事件生成的告警。 |
groupids | ID/数组 | 仅返回由来自给定主机组的对象生成的告警。 |
hostids | ID/数组 | 仅返回由来自给定主机的对象生成的告警。 |
mediatypeids | ID/数组 | 仅返回使用了给定媒体类型的消息告警。 |
objectids | ID/数组 | 仅返回由给定对象生成的告警。 |
userids | ID/数组 | 仅返回发送给给定用户的邮件告警。 |
eventobject | 整数 | 仅返回由与给定类型对象相关的事件生成的告警。 参见事件 object ,获取支持的对象类型列表。默认: 0 - 触发器。 |
eventsource | 整数 | 仅返回由给定类型的事件生成的告警。 参见事件 source ,获取支持的事件类型列表。默认: 0 - 触发器事件。 |
time_from | 时间戳 | 仅返回在给定时间之后生成的告警。 |
time_till | 时间戳 | 仅返回在给定时间之前生成的告警。 |
selectHosts | 查询 | 返回一个包含触发了动作操作的主机数据的[hosts] (/manual/api/reference/host/object)属性。 |
selectMediatypes | 查询 | 返回一个包含用于邮件告警的媒体类型数组的[mediatypes] (/manual/api/reference/mediatype/object)属性。参见 [mediatype.get] (/manual/api/reference/mediatype/get),了解基于用户类型的限制。 |
selectUsers | 查询 | 返回一个包含邮件收件人用户的数组的[users] (/manual/api/reference/user/object)属性。参见 [user.get] (/manual/api/reference/user/get),了解基于用户类型的限制。 |
sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值: alertid , clock , eventid , mediatypeid , sendto , status 。 |
countOutput | 布尔值 | 这些参数在参考说明中有描述。 |
editable | 布尔值 | |
excludeSearch | 布尔值 | |
filter | 对象 | |
limit | 整数 | |
output | 查询 | |
preservekeys | 布尔值 | |
search | 对象 | |
searchByAny | 布尔值 | |
searchWildcardsEnabled | 布尔值 | |
sortorder | 字符串/数组 | |
startSearch | 布尔值 |
在Zabbix 7.0.9中,管理员和用户类型用户可能仅检索关于他们自己的用户“消息”(0)类型的告警数据。
(integer/array)
返回以下两者之一:
countOutput
参数,则返回检索到的对象的数量。检索由动作"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 文件中。