1 动作日志

描述

这些参数以及相应仪表板部件字段对象的可选属性值,可用于在 dashboard.createdashboard.update 方法中配置 操作日志 部件。

部件 fields 属性在创建或更新仪表板期间不会被验证。 这使用户能够修改内置部件并创建自定义部件,但也带来了错误创建或更新部件的风险。 为确保 操作日志 部件能够成功创建或更新,请参阅下表中列出的参数行为。

参数

以下参数适用于 操作日志 部件。

参数 type name value
刷新间隔 0 rf_rate 0 - 不刷新;
10 - 10 秒;
30 - 30 秒;
60 - (默认) 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - 15 分钟。
收件人 11 userids.0 用户 ID。

注意:要配置多个用户,请为每个用户创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。
操作 12 actionids.0 操作 ID。

注意:要配置多个操作,请为每个操作创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。
介质类型 13 mediatypeids.0 介质类型 ID。

注意:要配置多个介质类型,请为每个介质类型创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。
状态 0 statuses.0 0 - 进行中;
1 - 已发送/已执行;
2 - 失败。

注意:要配置多个值,请为每个值创建一个 dashboard widget field 对象,并在属性名称中使用递增的编号。
搜索字符串 1 message 任意字符串值。
时间周期 1 time_period._reference DASHBOARD._timeperiod - 将仪表板的时间周期选择器设置为数据源;
ABCDE._timeperiod - 将兼容的部件(其 Reference 参数设置为 "ABCDE")设置为数据源。

默认值:DASHBOARD._timeperiod

或者,您也可以仅在 FromTo 参数中设置时间周期。
From 1 time_period.from 绝对时间(YYYY-MM-DD hh:mm:ss)或相对时间语法(nownow/dnow/w-1w 等)中的有效时间字符串。

参数行为
- 如果未设置 Time period,则 supported
- 如果设置了 time_period.to,则 required
To 1 time_period.to 绝对时间(YYYY-MM-DD hh:mm:ss)或相对时间语法(nownow/dnow/w-1w 等)中的有效时间字符串。

参数行为
- 如果未设置 Time period,则 supported
- 如果设置了 time_period.from,则 required
排序条目依据 0 sort_triggers 3 - 时间(升序);
4 - (默认) 时间(降序);
5 - 类型(升序);
6 - 类型(降序);
7 - 状态(升序);
8 - 状态(降序);
11 - 收件人(升序);
12 - 收件人(降序)。
显示行数 0 show_lines 可能的值范围为 1-100。

默认值:25。

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置 动作日志 组件。 更多信息,请参考创建仪表盘

配置一个动作日志 组件

配置一个动作日志组件,用于展示按时间倒序排序的 10 个动作操作的详情。 同时设置仅展示发送邮件给用户 "1",但是发送失败的动作。

请求:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "actionlog",
                        "name": "Action log",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 0,
                                "name": "show_lines",
                                "value": 10
                            },
                            {
                                "type": 0,
                                "name": "sort_triggers",
                                "value": 3
                            },
                            {
                                "type": 11,
                                "name": "userids.0",
                                "value": 1
                            },
                            {
                                "type": 13,
                                "name": "mediatypeids.0",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "statuses.0",
                                "value": 2
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

响应:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参考