Table of Contents

映射 object

映射 object

以下objects与mapAPI直接相关.

拓扑图

地图 object 具有以下属性.

属性	数据类型	描述
sysmapid	ID	地图的ID. 属性行为: - 只读 - 必需用于 update 操作
height	integer	地图的高度(像素). 属性行为: - 必需用于 create 操作
name	string	地图名称. 属性行为: - 必需用于 create 操作
width	integer	地图的宽度(像素). 属性行为: - 必需用于 create 操作
backgroundid	ID	用作地图背景的图片ID.
background_scale	integer	是否启用背景图片按比例缩放. 可能值: 0 - 禁用缩放; 1 - (默认) 启用图片缩放.
expand_macros	integer	配置地图时是否在标签中展开宏. 可能值: 0 - (默认) 不展开宏; 1 - 展开宏.
expandproblem	integer	是否对只有一个问题的元素显示问题触发器. 可能值: 0 - 始终显示问题数量; 1 - (默认) 如果只有一个问题则显示问题触发器.
grid_align	integer	是否启用网格对齐. 可能值: 0 - 禁用网格对齐; 1 - (默认) 启用网格对齐.
grid_show	integer	是否在地图上显示网格. 可能值: 0 - 不显示网格; 1 - (默认) 显示网格.
grid_size	integer	地图网格大小(像素). 支持值: 20, 40, 50, 75 和 100. 默认: 50.
highlight	integer	是否启用图标高亮. 可能值: 0 - 禁用高亮; 1 - (默认) 启用高亮.
iconmapid	ID	地图上使用的图标映射ID.
label_format	integer	是否启用高级标签. 可能值: 0 - (默认) 禁用高级标签; 1 - 启用高级标签.
label_location	integer	地图元素标签位置. 可能值: 0 - (默认) 底部; 1 - 左侧; 2 - 右侧; 3 - Top.
label_string_host	string	主机元素的自定义标签. 属性行为: - 必需当 `label_type_host` 设置为 "custom" 时
label_string_hostgroup	string	主机组元素的自定义标签. 属性行为: - 必需当 `label_type_hostgroup` 设置为 "custom" 时
label_string_image	string	图片元素的自定义标签. 属性行为: - 必需当 `label_type_image` 设置为 "custom" 时
label_string_map	string	地图元素的自定义标签. 属性行为: - 必需当 `label_type_map` 设置为 "custom" 时
label_string_trigger	string	触发器元素的自定义标签. 属性行为: - 必需当 `label_type_trigger` 设置为 "custom" 时
label_type	integer	地图元素标签类型. 可能值: 0 - 标签; 1 - IP地址; 2 - (默认) 元素名称; 3 - 仅状态; 4 - 无.
label_type_host	integer	主机元素的标签类型. 可能值: 0 - 标签; 1 - IP地址; 2 - (默认) 元素名称; 3 - 仅状态; 4 - 无; 5 - 自定义.
label_type_hostgroup	integer	主机组元素的标签类型. 可能值: 0 - 标签; 2 - (默认) 元素名称; 3 - 仅状态; 4 - 无; 5 - 自定义.
label_type_image	integer	主机组元素的标签类型. 可能值: 0 - 标签; 2 - (默认) 元素名称; 4 - 无; 5 - 自定义.
label_type_map	integer	地图元素的标签类型. 可能值: 0 - 标签; 2 - (默认) 元素名称; 3 - 仅状态; 4 - 无; 5 - 自定义.
label_type_trigger	integer	触发器元素的标签类型. 可能值: 0 - 标签; 2 - (默认) 元素名称; 3 - 仅状态; 4 - 无; 5 - 自定义.
markelements	integer	是否高亮显示最近改变状态的地图元素. 可能值: 0 - (默认) 不高亮元素; 1 - 高亮元素.
severity_min	integer	将在地图上显示的触发器的最小严重性. 参考 trigger `severity` property 获取支持的触发器严重性列表.
show_element_label	integer	默认如何显示元素标签. 可能值: 0 - 始终显示; 1 - (默认) 自动隐藏.
show_link_label	integer	默认如何显示链接标签. 可能值: 0 - 始终显示; 1 - (默认) 自动隐藏.
show_unack	integer	问题应如何显示. 可能值: 0 - (默认) 显示所有问题计数; 1 - 仅显示未确认问题计数; 2 - 分别显示已确认和未确认问题计数.
userid	ID	地图所有者的用户ID.
private	integer	地图共享类型. 可能值: 0 - 公共地图; 1 - (默认) 私有地图.
show_suppressed	integer	是否显示被抑制的问题. 可能值: 0 - (默认) 隐藏被抑制的问题; 1 - 显示被抑制的问题.

地图元素

地图元素 object 定义了在地图上显示的 object。它具有以下属性。

属性	数据类型	描述
selementid	ID	地图元素的ID。属性行为: - 只读
elements	array	元素数据 object. 属性行为: - 必需如果 `elementtype` 设置为 "主机"、"map"、"trigger" 或 "主机组"
elementtype	integer	地图元素的类型。可能的值: 0 - 主机; 1 - map; 2 - trigger; 3 - 主机组; 4 - image. 属性行为: - 必需
iconid_off	ID	用于在默认状态下显示元素的图像的ID。属性行为: - 必需
areatype	integer	如何显示单独的主机组主机. 可能的值: 0 - (默认) 主机组元素将占据整个地图; 1 - 主机组元素将具有固定大小。
elementsubtype	integer	如何在地图上显示一个主机组元素。可能的值: 0 - (默认) 将主机组显示为单个元素; 1 - 分别显示组中的每个主机。
evaltype	integer	地图元素标签过滤条件评估方法。可能的值: 0 - (默认) AND / OR; 2 - OR.
height	integer	固定大小的主机组元素的高度（像素）。默认: 200.
iconid_disabled	ID	用于显示禁用地图元素的图像的ID。属性行为: - 支持如果 `elementtype` 设置为 "主机"、"map"、"trigger" 或 "主机组"
iconid_maintenance	ID	用于显示处于维护状态的地图元素的图像的ID。属性行为: - 支持如果 `elementtype` 设置为 "主机"、"map"、"trigger" 或 "主机组"
iconid_on	ID	用于显示有问题地图元素的图像的ID。属性行为: - 支持如果 `elementtype` 设置为 "主机"、"map"、"trigger" 或 "主机组"
label	string	元素的标签。
label_location	integer	地图元素标签的位置。可能的值: -1 - (默认) 默认位置; 0 - 底部; 1 - 左侧; 2 - 右侧; 3 - Top.
permission	integer	权限级别类型。可能的值: -1 - 无; 2 - 只读; 3 - 读写。
show_label	integer	如何显示元素标签。可能的值: -1 - (默认) 地图默认; 0 - 始终显示; 1 - 自动隐藏。
sysmapid	ID	元素所属的地图的ID。属性行为: - 只读
urls	array	地图元素URL。地图元素URL object 是地图元素-url.
use_iconmap	integer	是否必须对主机元素使用图标映射。可能的值: 0 - 不使用图标映射; 1 - (默认) 使用图标映射。
viewtype	integer	主机组元素放置算法。可能的值: 0 - (默认) 网格。
width	integer	固定大小的主机组元素的宽度（像素）。默认: 200.
x	integer	元素的X坐标（像素）。默认: 0.
y	integer	元素的Y坐标（像素）。默认: 0.
zindex	integer	用于排序地图元素的值（z-index）。默认: 0.

地图元素主机

地图元素主机 object 定义一个主机元素.

属性	数据类型	描述
hostid	ID	主机的 ID.

地图元素主机组

地图元素主机组 object 定义一个主机组元素.

属性	数据类型	描述
groupid	ID	主机组的ID.

地图元素地图

地图元素 Map object 定义一个地图元素.

属性	数据类型	描述
sysmapid	ID	地图的ID.

Map 元素触发器

地图元素触发器object定义一个或多个触发器元素.

属性	数据类型	描述
triggerid	ID	触发器的ID.

地图元素标签

地图元素标签object具有以下属性.

属性	数据类型	描述
tag	string	地图元素标签名称. 属性行为: - 必填
operator	integer	地图元素标签条件运算符. 可选值: 0 - (默认) 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在.
value	string	地图元素标签值.

地图元素 URL

地图元素URL object 定义了可用于特定地图元素的可点击链接。它具有以下属性：

属性	数据类型	描述
sysmapelementurlid	ID	地图元素URL的ID。属性行为: - 只读
name	string	链接标题。属性行为: - 必填
url	string	链接URL。属性行为: - 必填
selementid	ID	URL所属的地图元素的ID。

地图链接

地图链接object定义了两个地图元素之间的连接。它具有以下属性。

属性	数据类型	描述
linkid	ID	地图链接的ID。属性行为: - 只读
sysmapid	ID	链接所属地图的ID。
selementid1	ID	一端连接的第一个地图元素的ID。属性行为: - 必填
selementid2	ID	另一端连接的第二个地图元素的ID。属性行为: - 必填
drawtype	integer	链接线条绘制样式。可能的值: 0 - (默认) 实线; 2 - 粗线; 3 - 点线; 4 - 虚线。
color	string	线条颜色，十六进制颜色代码。默认: `000000`.
label	string	链接标签。
show_label	integer	如何显示链接标签。可能的值: -1 - (默认) 地图默认; 0 - 始终显示; 1 - 自动隐藏。
indicator_type	integer	选择链接指示器类型。可能的值: 0 - (默认) 静态链接; 1 - 触发器; 2 - 监控项值。
linktriggers	array	用作链接状态指示器的地图链接触发器。地图链接触发器object是地图链接触发器. 属性行为: - 必填如果`indicator_type`设置为"trigger" (1)。
itemid	ID	监控项的ID。属性行为: - 必填如果`indicator_type`设置为"监控项 value" (2)。
highlights	array	用作链接状态指示器的地图链接高亮。地图链接指示器object是地图链接指示器. 属性行为: - 必填如果`indicator_type`设置为"监控项 value" (2)。
thresholds	array	用作链接状态指示器的地图链接阈值。地图链接指示器object是地图链接指示器. 属性行为: - 必填如果`indicator_type`设置为"监控项 value" (2)。
permission	integer	权限级别类型。可能的值: -1 - 无; 2 - 只读; 3 - 读写。

地图链接触发器

地图链接触发器object基于触发器状态定义地图链接状态指示器。它具有以下属性：

属性	数据类型	描述
triggerid	ID	用作链接指示器的触发器ID。属性行为: - 必填
color	string	指示器颜色（十六进制颜色代码）。默认值: `DD0000`.
drawtype	integer	指示器绘制样式。可选值: 0 - (默认) 实线; 2 - 粗线; 3 - 点线; 4 - 虚线。

地图链接指示器

地图链接指示器object基于监控项值定义地图链接状态指示器. 它具有以下属性:

属性	数据类型	描述
pattern	string	用于匹配的正则表达式. 仅适用于高亮显示.
sortorder	integer	用于定义高亮显示排序顺序. 仅适用于高亮显示.
threshold	string	用于匹配的数值. 仅适用于阈值.
drawtype	integer	指示器绘制样式. 可能的值: 0 - (默认) 线条; 2 - 粗线; 3 - 点线; 4 - 虚线.
color	string	指示器颜色(十六进制颜色代码). 默认: `DD0000`. 属性行为: - 必填

地图 URL

地图URL object 定义了可点击链接，该链接将在地图上特定类型的所有元素上可用。它具有以下属性：

属性	数据类型	描述
sysmapurlid	ID	地图URL的ID。属性行为: - 只读
name	string	链接标题。属性行为: - 必填
url	string	链接URL。属性行为: - 必填
elementtype	integer	URL将可用的地图元素类型。参考map element `type` property获取支持的类型列表。默认值: 0.
sysmapid	ID	URL所属地图的ID。

地图用户

基于用户的网络地图权限列表。该列表具有以下属性：

属性	数据类型	描述
sysmapuserid	ID	地图用户的ID。属性行为: - 只读
userid	ID	用户ID。属性行为: - 必填
permission	integer	权限级别类型。可能的值： 2 - 只读； 3 - 读写。属性行为: - 必填

映射用户组

基于用户组的地图权限列表。具有以下属性：

属性	数据类型	描述
sysmapusrgrpid	ID	地图用户组的ID。属性行为: - 只读
usrgrpid	ID	用户组的ID。属性行为: - 必填
permission	integer	权限级别类型。可能的值： 2 - 只读； 3 - 读写。属性行为: - 必填

地图形状

地图形状object定义了在地图上显示的几何形状（可带或不带文本）。它具有以下属性：

属性	数据类型	描述
sysmap_shapeid	ID	地图形状元素的ID。属性行为: - 只读
type	integer	地图形状元素的类型。可选值： 0 - 矩形； 1 - 椭圆。创建新形状时该属性为必填项。属性行为: - 必填
x	integer	形状的X坐标（像素单位）。默认值：0。
y	integer	形状的Y坐标（像素单位）。默认值：0。
width	integer	形状的宽度（像素单位）。默认值：200。
height	integer	形状的高度（像素单位）。默认值：200。
text	string	形状内的文本内容。
font	integer	形状内文本的字体。可选值： 0 - Georgia, serif 1 - “Palatino Linotype”, “Book Antiqua”, Palatino, serif 2 - “Times New Roman”, Times, serif 3 - Arial, Helvetica, sans-serif 4 - “Arial Black”, Gadget, sans-serif 5 - “Comic Sans MS”, cursive, sans-serif 6 - Impact, Charcoal, sans-serif 7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif 8 - Tahoma, Geneva, sans-serif 9 - “Trebuchet MS”, Helvetica, sans-serif 10 - Verdana, Geneva, sans-serif 11 - “Courier New”, Courier, monospace 12 - “Lucida Console”, Monaco, monospace 默认值：9。
font_size	integer	字体大小（像素单位）。默认值：11。
font_color	string	字体颜色。默认值：`000000`。
text_halign	integer	文本水平对齐方式。可选值： 0 - 居中； 1 - 左对齐； 2 - 右对齐。默认值：0。
text_valign	integer	文本垂直对齐方式。可选值： 0 - 垂直居中； 1 - Top； 2 - 底部对齐。默认值：0。
border_type	integer	边框类型。可选值： 0 - 无边框； 1 - `—————`； 2 - `·····`； 3 - `- - -`。默认值：0。
border_width	integer	边框宽度（像素单位）。默认值：0。
border_color	string	边框颜色。默认值：`000000`。
background_color	string	背景颜色（填充色）。默认值：`(empty)`。
zindex	integer	用于排序所有形状和线条的值（z-index）。默认值：0。

地图连线

地图线条object定义了在地图上显示的线条. 它具有以下属性:

属性	数据类型	描述
sysmap_shapeid	ID	地图形状元素的ID. 属性行为: - 只读
x1	integer	线条点1的X坐标(像素单位). 默认值: 0.
y1	integer	线条点1的Y坐标(像素单位). 默认值: 0.
x2	integer	线条点2的X坐标(像素单位). 默认值: 200.
y2	integer	线条点2的Y坐标(像素单位). 默认值: 200.
line_type	integer	线条类型. 可选值: 0 - 无; 1 - `—————`; 2 - `·····`; 3 - `- - -`. 默认值: 0.
line_width	integer	线条宽度(像素单位). 默认值: 0.
line_color	string	线条颜色. 默认值: `000000`.
zindex	integer	用于排序所有形状和线条的值(z-index). 默认值: 0.

Documentation