拓扑图对象

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

拓扑图

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

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

属性行为：
- 只读
- 必需 更新操作
heightinteger拓扑图的高度，以像素为单位。

属性行为：
- 必需 创建操作
namestring拓扑图的名称。

属性行为：
- 必需 更新操作
widthinteger拓扑图的宽度，以像素为单位。

属性行为：
- 必需 创建操作
backgroundidID用作拓扑图背景的图像的 ID。
expand_macrosinteger配置拓扑图时是否展开标签中的宏。

可能的值：
0 - (默认) 不展开宏;
1 - 展开宏。
expandprobleminteger是否为具有单个问题的元素显示问题触发器。

可能的值：
0 - 始终显示问题数量;
1 - (默认) 如果只有一个问题，则显示问题触发器。
grid_aligninteger是否启用网格对齐。

可能的值：
0 - 禁用网格对齐;
1 - (默认) 启用网格对齐。
grid_showinteger是否在拓扑图上显示网格。

可能的值：
0 - 不显示网格;
1 - (默认) 显示网格。
grid_sizeinteger拓扑图网格的大小，以像素为单位。

支持的值： 20, 40, 50, 75 和 100。

默认: 50。
highlightinteger是否启用图标突出显示。

可能的值：
0 - 突出显示已禁用；
1 - (默认) 突出显示已启用。
iconmapidID拓扑图上使用的图标拓扑图的 ID。
label_formatinteger是否启用高级标签。

Possible values:
0 - (默认) 禁用高级标签；
1 - 启用高级标签。
label_locationinteger拓扑图元素标签的位置。

可能的值：
0 - (默认) 底部;
1 - 左边;
2 - 右边;
3 - 顶部。
label_string_hoststring宿主元素的自定义标签。

属性行为:
- 必需 “如果 label_type_host 设置为“自定义”
label_string_hostgroupstring主机组元素的自定义标签。

属性行为:
- 必需 如果 label_type_hostgroup 设置为 “自定义”
label_string_imagestring图像元素的自定义标签。

属性行为:
- 必需 如果 label_type_image 设置为 “自定义”
label_string_mapstring拓扑图元素的自定义标签。

属性行为:
- 必需 如果 label_type_map 设置为 “自定义”
label_string_triggerstring触发元素的自定义标签。

属性行为:
- 必需 如果 label_type_trigger 设置为 “自定义”
label_typeinteger拓扑图元素标签类型。

可能的值：
0 - 标签;
1 - IP 地址;
2 - (默认) 元素名称;
3 - 仅状态;
4 - 空。
label_type_hostinteger主机元素的标签类型。

可能的值：
0 - 标签;
1 - IP 地址;
2 - (默认) 元素名称;
3 - 只显示状态;
4 - 空;
5 - 自定义。
label_type_hostgroupinteger主机组元素的标签类型。

可能的只值：
0 - 标签;
2 - (默认) 元素名称;
3 - 只显示状态;
4 - 空;
5 - 自定义
label_type_imageinteger主机组元素的标签类型。

可能的值：
0 - 标签;
2 - (默认) 元素名称;
4 - 空;
5 - 自定义。
label_type_mapinteger拓扑图元素的标签类型。

可能的值：
0 - 标签;
2 - (默认) 元素名称;
3 - 只显示状态;
4 - 空;
5 - 自定义。
label_type_triggerinteger触发器元素的标签类型。

可能的值：
0 - 标签;
2 - (默认) 元素名称;
3 - 只显示状态;
4 - 空;
5 - 自定义
markelementsinteger是否突出显示最近更改状态的拓扑图元素。

可能的值：
0 - (默认) 不突出显示元素;
1 - 突出显示元素。
severity_mininteger将在拓扑图上显示触发器的最低严重性。

请参阅触发器“严重性”属性 以获取支持的触发器严重性列表。
show_unackinteger问题应该如何显示。

可能的值：
0 - (默认) 显示所有问题的计数；
1 - 仅显示未确认问题的计数；
2 - 分别显示已确认和未确认问题的计数。
useridID作为拓扑图所有者的用户 ID。
privateinteger拓扑图共享的类型。

可能的值：
0 - 公共拓扑图；
1 - (默认) 私有拓扑图。
show_suppressedinteger是否显示被抑制的问题。

可能的值：
0 - (默认) 隐藏被抑制的问题；
1 - 显示被抑制的问题。

拓扑图元素

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

属性类型说明
selementidID拓扑图元素的 ID。

属性行为：
- 只读
elementsarray元素数据对象。

属性行为：
- 必需的 如果 elementtype 设置为”host”、”map”、”trigger”或”host group”
elementtypeinteger拓扑图元素的类型。

参考值：
0 - 主机;
1 - 拓扑;
2 - 触发器;
3 - 主机组;
4 - 图片。

属性行为：
- 必需的
iconid_offID默认状态下用于显示元素的图像的ID。

属性行为：
- 必需的
areatypeinteger应如何显示单独的主机组主机。

参考值：
0 - (默认) 主机组元素将占据整个拓扑图;
1 - 主机组元素将具有固定大小。
elementsubtypeinteger主机组元素应如何在拓扑图上显示。

参考值：
0 - (默认) 将主机组显示为单个元素;
1 - 分别显示组中的每个主机。
evaltypeinteger拓扑图元素标签过滤条件评估方法。

参考值：
0 - (默认值) AND / OR;
2 - OR.
heightinteger固定大小的主机组元素的高度，以像素为单位。

默认值： 200。
iconid_disabledID用于显示禁用的拓扑图元素的图像的 ID。

属性行为：
- 必需的 如果 elementtype 设置为”host”、”map”、”trigger”或”host group”
iconid_maintenanceID维护时用于显示拓扑图元素的图片ID。

属性行为：
- 必需的 如果 elementtype 设置为”host”、”map”、”trigger”或”host group”
iconid_onID用于显示有问题的拓扑图元素的图像的 ID。

属性行为：
- supported 如果 elementtype 设置为”host”、”map”、”trigger”或”host group”
labelstring元素的标签。
label_locationinteger拓扑图元素标签的位置。

参考值：
-1 - (默认) 默认位置;
0 - 底部;
1 - 左;
2 - 右;
3 - 顶部。
permissioninteger权限级别类型。

参考值：
-1 - 空;
2 - 只读;
3 - 可读可写。
sysmapidID元素所属的拓扑图的 ID。

属性行为：
- 只读
urlsarray拓扑图元素 URL。

拓扑图元素URL对象是下面详细描述。
use_iconmapinteger宿主元素是否必须使用图标映射。

参考值：
0 - 不使用图标映射;
1 - (默认值) 使用图标映射。
viewtypeinteger主机组元素放置算法。

参考值：
0 - (默认) 网格。
widthinteger以像素为单位，固定大小主机组元素的宽度。

默认值： 200。
xinteger以像素为单位，元素的 X 坐标。

默认值： 0。
yinteger以像素为单位，元素的 Y 坐标。

默认值： 0。

拓扑图元素的主机

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

属性类型说明
hostidID主机 ID。

拓扑图元素中的主机组

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

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

拓扑图元素中的拓扑图

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

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

拓扑图元素中的触发器

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

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

拓扑图元素标签

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

属性类型说明
tagstring拓扑图元素标签名称。

属性行为：
- 必需
operatorinteger拓扑图元素标记条件运算符。

参考值：
0 - (默认值) 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在
5 - 不存在。
valuestring拓扑图元素标签值。

拓扑图元素URL

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

属性类型说明
sysmapelementurlidID拓扑图元素URL ID.

属性行为:
- 只读
namestring链接标题。

属性行为:
- 必需
urlstring链接URL。

属性行为:
- 必需
selementidID所属URL的拓扑图元素ID

拓扑图链接

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

属性类型说明
linkid拓扑图链接的 ID。

属性行为:
- 只读
selementid1ID连接在一端的第一个拓扑图元素的 ID。

属性行为:
- 必需
selementid2ID连接到另一端的第一个拓扑图元素的 ID。

属性行为:
- 必需
colorstring作为十六进制颜色代码的线条颜色。

默认值： 000000.
drawtypeinteger链接线绘制样式。

参考值
0 - (默认) 线;
2 - 粗线;
3 - 点虚线;
4 - 虚线。
labelstring链接标签。
linktriggersarray拓扑图链接触发器用作链接状态指示器。

拓扑图链接触发器对象详细描述如下。
permissioninteger权限级别的类型。

参考值：
-1 - 空;
2 - 只读;
3 - 可读可写。
sysmapidID链接所属拓扑图的ID。

拓扑图链接触发器

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

属性类型说明
linktriggeridID拓扑图链接触发器的ID。

属性行为:
- 只读
triggeridID用于链接指标的触发器的ID。

属性行为:
- 必需的
colorstring指示器颜色为十六进制颜色代码。

默认值：DD0000。
drawtypeinteger指标绘制风格。

参考值：
0 - (默认值) line;
2 - 粗线;
3 - 点虚线;
4 - 虚线。
linkidID链接触发器所属的拓扑链接ID。

拓扑图URL

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

属性类型说明
sysmapurlidID拓扑图URL ID。

属性行为：
- 只读
namestring链接标题。

属性行为：
- 必需的
urlstring链接 URL。

属性行为：
- 必需的
elementtypeinteger可以使用在URL上的拓扑图元素类型。

请参考 拓扑图元素”类型”属性 。

默认值： 0。
sysmapidID所属URL的拓扑图ID。

拓扑图用户

基于用户的拓扑图权限列表。它具有以下特性：

属性类型说明
sysmapuseridID拓扑图用户ID。

属性行为：
- 只读
useridID用户 ID。

属性行为：
- 必需的
permissioninteger权限级别类型。

参考值：
2 - 只读;
3 - 可读可写。

属性行为：
- 必需的

拓扑图用户组

基于用户组的拓扑图权限列表。它具有以下特性:

属性类型说明
sysmapusrgrpidID拓扑图用户组的ID。

属性行为：
- 只读
usrgrpidID用户组ID。

属性行为：
- 必需的
permissioninteger权限级别类型。

参考值：
2 - 只读;
3 - 可读-可写。

属性行为：
- 必需的

拓扑图形状

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

属性类型描述
sysmap_shapeidID拓扑图形状元素的 ID。

属性行为:
- 只读
typeinteger拓扑图形状元素的类型。

参考值：
0 - 矩形；
1 - 椭圆。

创建新形状时需要属性。

属性行为:
- 必需的
xinteger以像素为单位的形状的 X 坐标。

默认值： 0。
yinteger以像素为单位的形状的 Y 坐标。

默认值： 0。
widthinteger形状的宽度，以像素为单位。

默认值： 200。
heightinteger形状的高度，以像素为单位。

默认值： 200。
textstring形状的文本。
fontinteger形状内文本的字体。

参考值：
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_sizeinteger字体大小，以像素为单位。

默认值： 11。
font_colorstring字体颜色。

默认值： 000000。
text_haligninteger文本的水平对齐方式

参考值：
0 - 居中;
1 - 左;
2 - 右。

默认值： 0。
text_valigninteger文本垂直对齐。

参考值：
0 - 中间;
1 - 顶部;
2 - 底部。

默认值： 0。
border_typeinteger边框的类型。

参考值：
0 - none;
1 - —————;
2 - ·····;
3 - - - -。

默认值： 0。
border_widthinteger边框的宽度，以像素为单位。

默认值： 0。
border_colorstring边框颜色。

默认值： 000000。
background_colorstring背景颜色（填充颜色）。

D默认值： （空）。
zindexinteger用于对所有形状和线条进行排序的值 (z-index)。

默认值： 0。

拓扑图线

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

属性类型描述
sysmap_shapeidID拓扑图形状元素的 ID。

属性行为:
- 只读
x1integer线点 1 的 X 坐标，以像素为单位。

默认值: 0。
y1integer线点 1 的 Y 坐标，以像素为单位。

默认值: 0。
x2integer线点 2 的 X 坐标，以像素为单位。

默认值: 200。
y2integer线点 2 的 Y 坐标，以像素为单位。

默认值: 200。
line_typeinteger线条的类型。

可能的值：
0 - none;
1 - —————;
2 - ·····;
3 - - - -.

默认值: 0。
line_widthinteger线条的宽度，以像素为单位。

默认值: 0。
line_colorstring线条颜色。

默认值: 000000。
zindexinteger用于对所有形状和线条进行排序的值 (z-index)。

默认值: 0。