Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> 目标:报告

接下来介绍有关report(报告) API 的相关内容。

报告

报告对象具有以下属性:

属性 类型 说明
reportid 字符串 (只读) 报告的ID号。
userid
(必要)
字符串 创建该报告的用户ID号。
name
(必要)
字符串 报告的独有名称。
dashboardid
(必要)
字符串 产生报告的仪表ID号。
period 整数 报告所要准备的时间区间。

可设置的参数包括:
0 - (缺省值)) 前一天;
1 - 前一周;
2 - 前一月;
3 - 前一年。
cycle 整数 报告重复发送的周期。

可设置的参数包括:
0 - (缺省值)) 以“天”为单位;
1 - 以“周”为单位;
2 - 以“月”为单位;
3 - 以“年”为单位。
start_time 整数 以“秒”为单位的一天中的精确时间,该时间设定为报告何时发送。

缺省值: 0。
weekdays 整数 确认一周中有哪几天发送报告。

只有当配置为周报形式下才会需要配置该参数。

一周中的周几发送数据是以二进制的形式进行存储的。二进制下,每一位都代表着对应的天数。例如,十进制数字12转换为二进制为1100,这意味着每周的周三和周四将发送报告。

缺省值: 0。
active_since 字符串 报告的起始日期。

可配置的数值包括:
无输入 - (缺省值) 对该参数不做配置(存储为0);
设定日期格式为YYYY-MM-DD(以每天凌晨(00:00:00)为基准,存储一个时间戳)。
active_till 字符串 报告的终了时间。

可配置的数值包括:
无输入 - (缺省值)) 对该参数不做配置(存储为0);
设定日期格式为YYYY-MM-DD(以每天凌晨(23:59:59)为基准,存储一个时间戳)。
subject 字符串 报告消息主题。
message 字符串 报告消息内容。
status 整数 该参数用来表示报告状态为启动还是关闭。

可配置的数值为:
0 - 关闭;
1 - (缺省值) 启动。
description 文本 报告的文字描述。
state 整数 (只读) 报告的状态。

可配置的数值包括:
0 - (缺省值)) 报告还未处理;
1 - 报告已生成且发送至所有目标;
2 - 报告生成失败;"info" 中包含有关发生错误的信息;
3 - 报告生成成功,但是未能发送指某些(或全部)目标;"info" 中包含有关发生错误的信息。
lastsent timestamp (只读) 在Unix系统下,最后成功发送报告的时间戳。
info 字符串 (只读) 有关错误的详细说明或者其他附加信息。

用户

用户对象包含下列属性特征:

属性 类型 说明
userid
(必要)
字符串 需要发送报告的对象用户ID。
access_userid 字符串 将为其生成报告的用户ID。

0 - (缺省值) 按收件人生成报告。
exclude 整数 从发送的用户名单中删除目标用户。

Possible values:
0 - (缺省值) 包含;
1 - 删除。

用户组

用户组对象包含以下属性: |属性|类型|说明| |--------|---------------------------------------------------|-----------| |usrgrpid
(必要)|字符串|发送报告的用户组ID。| |access_userid|字符串|将为其生成报告的用户组ID。

0 - (缺省值) 按收件人生成报告。|