8 地理地图(Geomap)

说明

各个仪表盘组件字段对象中的这些参数和可用属性值允许在dashboard.createdashboard.update 方法中配置地理地图(Geomap)组件。

在创建或更新仪表盘期间不会验证组件的 fields 属性。 这个方法允许用户修改内置组件和创建自定义组件,但也会导致存在错误创建或更新组件的风险。 为确保成功创建或更新地理地图(Geomap)组件,请参阅下表中概述的参数行为。

参数

地理地图(Geomap)组件支持以下参数:

参数 类型 参数名称 参数值或参数说明
刷新频率 0 rf_rate 0 - 不刷新;
10 - 10 秒;
30 - 30 秒;
60 - (默认) 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - 15 分钟。
主机组 2 groupids.0 主机组 ID。

注意:如果需要配置多个主机组,则需要给每个主机组创建一个仪表盘组件字段对象,参数名称 groupids.0 中的数字按照顺序进行递增。

仪表盘模板上配置组件时,这个参数不受支持。
主机组 (组件) 1 groupids._reference 用于替代主机组 ID:
ABCDE._hostgroupids - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

仪表盘模板上配置组件时,这个参数不受支持。
主机 3 hostids.0 主机 ID.

注意:如果需要配置多个主机,则需要给每个主机创建一个仪表盘组件字段对象,参数名称 hostids.0 中的数字按照顺序进行递增。配置多个主机时,主机组 必须不进行配置或配置中至少包含一个主机所属的主机组。

仪表盘模板上配置组件时,这个参数不受支持。
主机 (组件/仪表盘) 1 hostids._reference 用于替代主机 ID:
DASHBOARD.hostids - 将主机选择器作为数据源;
ABCDE._hostids - 将一个 标识符 参数为 ABCDE兼容性组件作为数据源。

仪表盘模板上配置组件时,这个参数不受支持。
标签
评估类型 0 evaltype 0 - (默认) And/Or;
2 - Or。

仪表盘模板上配置组件时,这个参数不受支持。
标签名称 1 tags.0.tag 任意字符串。

注意:参数名称 tags.0.value 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。

参数行为
- 必需的 (配置 标签 时)。

仪表盘模板上配置组件时,这个参数不受支持。
操作 0 tags.0.operator 0 - 包含;
1 - 相等;
2 - 不包含;
3 - 不相等;
4 - 存在;
5 - 不存在。

注意:参数名称 tags.0.value 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。

参数行为
- 必需的 (配置 标签 时)。

仪表盘模板上配置组件时,这个参数不受支持。
标签值 1 tags.0.value 任意字符串。

注意:参数名称 tags.0.value 中的数字与提供的参数列表需要一致,例如:总数为 3,则下标参数名称中的数字分别为:0、1、2。

参数行为
- 必需的 (配置 标签 时)。

仪表盘模板上配置组件时,这个参数不受支持。
初始视图 1 default_view 逗号分隔的 纬度经度缩放级别 (可选,可用值范围:0-30)。
示例: 40.6892494,-74.0466891,10
标识符 1 reference 任意 5 个英文字符组成的字符串(例如:ABCDEJBPNL)。在这个组件所属的仪表盘中,这个值必须是唯一的。

参数行为
- 必需的

示例

以下示例仅用于介绍如何在仪表盘组件字段对象中配置地理地图(Geomap)组件。 更多信息,请参考创建仪表盘

配置一个地理地图(Geomap)组件

配置一个地理地图(Geomap)组件,用于展示主机组 "2" 和 "22" 中符合以下标签配置的主机: 标签名称为 "component",标签值为"node";标签名称为 "location",标签值为 "New York"。 同时,将地图初始视图设置为:坐标为 "40.6892494"(纬度)、"-74.04668991"(经度),缩放级别为 "10"。

请求:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "geomap",
                        "name": "Geomap",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 22
                            },
                            {
                                "type": 2,
                                "name": "groupids.1",
                                "value": 2
                            },
                            {
                                "type": 1,
                                "name": "default_view",
                                "value": "40.6892494,-74.0466891,10"
                            },
                            {
                                "type": 0,
                                "name": "evaltype",
                                "value": 2
                            },
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "node"
                            },
                            {
                                "type": 1,
                                "name": "tags.1.tag",
                                "value": "location"
                            },
                            {
                                "type": 0,
                                "name": "tags.1.operator",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "tags.1.value",
                                "value": "New York"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

响应:

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

参考