Table of Contents

拓扑图对象

拓扑图对象

以下对象与 拓扑图 API 直接相关。

拓扑图

拓扑图对象具有以下属性。

属性	类型	描述
sysmapid	ID	拓扑图 ID。属性行为： - 只读 - 必需更新操作
height	integer	拓扑图的高度，以像素为单位。属性行为： - 必需创建操作
name	string	拓扑图的名称。属性行为： - 必需更新操作
width	integer	拓扑图的宽度，以像素为单位。属性行为： - 必需创建操作
backgroundid	ID	用作拓扑图背景的图像的 ID。
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	是否启用高级标签。 Possible values: 0 - (默认) 禁用高级标签； 1 - 启用高级标签。
label_location	integer	拓扑图元素标签的位置。可能的值： 0 - (默认) 底部; 1 - 左边; 2 - 右边; 3 - 顶部。
label_string_host	string	宿主元素的自定义标签。属性行为: - 必需 "如果 `label_type_host` 设置为“自定义”
label_string_hostgroup	string	主机组元素的自定义标签。属性行为: - 必需如果 `label_type_hostgroup` 设置为 "自定义"
label_string_image	string	图像元素的自定义标签。属性行为: - 必需如果 `label_type_image` 设置为 "自定义"
label_string_map	string	拓扑图元素的自定义标签。属性行为: - 必需如果 `label_type_map` 设置为 "自定义"
label_string_trigger	string	触发元素的自定义标签。属性行为: - 必需如果 `label_type_trigger` 设置为 "自定义"
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	将在拓扑图上显示触发器的最低严重性。请参阅触发器“严重性”属性以获取支持的触发器严重性列表。
show_unack	integer	问题应该如何显示。可能的值： 0 - (默认) 显示所有问题的计数； 1 - 仅显示未确认问题的计数； 2 - 分别显示已确认和未确认问题的计数。
userid	ID	作为拓扑图所有者的用户 ID。
private	integer	拓扑图共享的类型。可能的值： 0 - 公共拓扑图； 1 - (默认) 私有拓扑图。
show_suppressed	integer	是否显示被抑制的问题。可能的值： 0 - (默认) 隐藏被抑制的问题； 1 - 显示被抑制的问题。

拓扑图元素

拓扑图元素对象定义了在拓扑图上显示的对象。它有以下属性。

属性	类型	说明
selementid	ID	拓扑图元素的 ID。属性行为： - 只读
elements	array	元素数据对象。属性行为： - 必需的如果 `elementtype` 设置为"host"、"map"、"trigger"或"host group"
elementtype	integer	拓扑图元素的类型。参考值： 0 - 主机; 1 - 拓扑; 2 - 触发器; 3 - 主机组; 4 - 图片。属性行为： - 必需的
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` 设置为"host"、"map"、"trigger"或"host group"
iconid_maintenance	ID	维护时用于显示拓扑图元素的图片ID。属性行为： - 必需的如果 `elementtype` 设置为"host"、"map"、"trigger"或"host group"
iconid_on	ID	用于显示有问题的拓扑图元素的图像的 ID。属性行为： - supported 如果 `elementtype` 设置为"host"、"map"、"trigger"或"host group"
label	string	元素的标签。
label_location	integer	拓扑图元素标签的位置。参考值： -1 - (默认) 默认位置; 0 - 底部; 1 - 左; 2 - 右; 3 - 顶部。
permission	integer	权限级别类型。参考值： -1 - 空; 2 - 只读; 3 - 可读可写。
sysmapid	ID	元素所属的拓扑图的 ID。属性行为： - 只读
urls	array	拓扑图元素 URL。拓扑图元素URL对象是下面详细描述。
use_iconmap	integer	宿主元素是否必须使用图标映射。参考值： 0 - 不使用图标映射; 1 - (默认值) 使用图标映射。
viewtype	integer	主机组元素放置算法。参考值： 0 - (默认) 网格。
width	integer	以像素为单位，固定大小主机组元素的宽度。默认值： 200。
x	integer	以像素为单位，元素的 X 坐标。默认值： 0。
y	integer	以像素为单位，元素的 Y 坐标。默认值： 0。

拓扑图元素的主机

拓扑图元素中的主机对象定义一个主机元素。

属性	类型	说明
hostid	ID	主机 ID。

拓扑图元素中的主机组

拓扑图元素中的主机组对象定义是一个主机组元素。

属性	类型	描述
groupid	ID	主机组 ID。

拓扑图元素中的拓扑图

拓扑图元素拓扑图对象定义一个拓扑图元素。

属性	类型	描述
sysmapid	ID	拓扑图 ID。

拓扑图元素中的触发器

拓扑图元素中的触发器对象定义的是一个或者多个触发器元素。

属性	类型	描述
triggerid	ID	触发器的 ID。

拓扑图元素标签

拓扑图元素标签对象具有以下属性。

属性	类型	说明
tag	string	拓扑图元素标签名称。属性行为： - 必需
operator	integer	拓扑图元素标记条件运算符。参考值： 0 - (默认值) 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在 5 - 不存在。
value	string	拓扑图元素标签值。

拓扑图元素URL

拓扑图元素 URL 对象定义可用于特定拓扑图元素的可点击链接。它具有以下属性：

属性	类型	说明
sysmapelementurlid	ID	拓扑图元素URL ID. 属性行为: - 只读
name	string	链接标题。属性行为: - 必需
url	string	链接URL。属性行为: - 必需
selementid	ID	所属URL的拓扑图元素ID

拓扑图链接

拓扑图链接对象定义了两个拓扑图元素之间的链接。它有以下属性：

属性	类型	说明
linkid	拓扑图链接的 ID。属性行为: - 只读
selementid1	ID	连接在一端的第一个拓扑图元素的 ID。属性行为: - 必需
selementid2	ID	连接到另一端的第一个拓扑图元素的 ID。属性行为: - 必需
color	string	作为十六进制颜色代码的线条颜色。默认值： `000000`.
drawtype	integer	链接线绘制样式。参考值 0 - (默认) 线; 2 - 粗线; 3 - 点虚线; 4 - 虚线。
label	string	链接标签。
linktriggers	array	拓扑图链接触发器用作链接状态指示器。拓扑图链接触发器对象详细描述如下。
permission	integer	权限级别的类型。参考值： -1 - 空; 2 - 只读; 3 - 可读可写。
sysmapid	ID	链接所属拓扑图的ID。

拓扑图链接触发器

拓扑链接触发器根据触发器的状态定义了拓扑图链接状态指标，它具有以下属性：

属性	类型	说明
linktriggerid	ID	拓扑图链接触发器的ID。属性行为: - 只读
triggerid	ID	用于链接指标的触发器的ID。属性行为: - 必需的
color	string	指示器颜色为十六进制颜色代码。默认值：`DD0000`。
drawtype	integer	指标绘制风格。参考值： 0 - (默认值) line; 2 - 粗线; 3 - 点虚线; 4 - 虚线。
linkid	ID	链接触发器所属的拓扑链接ID。

Map link indicators

The map link indicators object defines a map link status indicator based on the item value. It has the following properties:

Property	Type	Description
pattern	string	Regular expression to compare against. Available only for highlights.
sortorder	integer	Used for defining the sort order of highlights. Available only for highlights.
threshold	string	Numeric value to compare against. Available only for thresholds.
drawtype	integer	Indicator draw style. Possible values: 0 - (default) line; 2 - bold line; 3 - dotted line; 4 - dashed line.
color	string	Indicator color as a hexadecimal color code. Default: `DD0000`. Property behavior: - required

拓扑图URL

拓扑图URL对象定义了一个可点击的链接，可用于映射上特定类型的所有元素。它具有以下特性:

属性	类型	说明
sysmapurlid	ID	拓扑图URL ID。属性行为： - 只读
name	string	链接标题。属性行为： - 必需的
url	string	链接 URL。属性行为： - 必需的
elementtype	integer	可以使用在URL上的拓扑图元素类型。请参考拓扑图元素"类型"属性。默认值： 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 - 可读-可写。属性行为： - 必需的

拓扑图形状

拓扑图形状对象定义了在拓扑图上显示的几何形状（有或没有文本）。它具有以下属性：

属性	类型	描述
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 - 顶部; 2 - 底部。默认值： 0。
border_type	integer	边框的类型。参考值： 0 - none; 1 - `—————`; 2 - `·····`; 3 - `- - -`。默认值： 0。
border_width	integer	边框的宽度，以像素为单位。默认值： 0。
border_color	string	边框颜色。默认值： `000000`。
background_color	string	背景颜色（填充颜色）。 D默认值： `（空）`。
zindex	integer	用于对所有形状和线条进行排序的值 (z-index)。默认值： 0。

拓扑图线

该对象定义在拓扑图上显示的线。它有以下属性：

属性	类型	描述
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 - none; 1 - `—————`; 2 - `·····`; 3 - `- - -`. 默认值: 0。
line_width	integer	线条的宽度，以像素为单位。默认值: 0。
line_color	string	线条颜色。默认值: `000000`。
zindex	integer	用于对所有形状和线条进行排序的值 (z-index)。默认值: 0。

Documentation