Table of Contents
> 拓扑图对象
拓扑图
拓扑图对象具有以下属性.
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmapid | string | (只读) 拓扑图 ID. |
| height （必需） |
整数 | 拓扑图的高度，以像素为单位. |
| name （必填） |
字符串 | 拓扑图名称. |
| width （必需） |
整数 | 拓扑图的宽度，以像素为单位. |
| backgroundid | 字符串 | 用作拓扑图背景的图像ID. |
| expand_macros | 整数 | 配置拓扑图时是否在标签中展开宏. 参考值: 0 - （默认）不展开宏； 1 - 展开宏. |
| expandproblem | 整数 | 是否为具有单个问题的元素显示问题触发器. 参考值： 0 - 始终显示问题的数量； 1 - （默认） 如果只有一个问题，则显示问题触发器. |
| grid_align | 整数 | 是否启用网格对齐. 参考值： 0 - 禁用网格对齐； 1 - （默认） 启用网格对齐. |
| grid_show | 整数 | 是否在拓扑图上显示网格. 参考值： 0 - 不显示网格； 1 - （默认） 显示网格. |
| grid_size | 整数 | 拓扑图网格的大小（以像素为单位）. 支持的值：20、40、50、75 和 100. 默认值：50. |
| highlight | 整数 | 是否启用图标突出显示. 参考值： 0 - 突出显示禁用； 1 - （默认） 突出显示启用. |
| iconmapid | 字符串 | 拓扑图上使用的图标拓扑图的ID. |
| label_format | 整数 | 是否启用高级标签. 参考值： 0 - （默认） 禁用高级标签； 1 - 启用高级标签. |
| label_location | 整数 | 拓扑图元素标签的位置. 参考值： 0 - （默认） 底部； 1 - 左； 2 - 右；< br>3 - 顶部. |
| label_string_host | 字符串 | 主机元素的自定义标签. 对于具有自定义主机标签类型的拓扑图是必需的. |
| label_string_hostgroup | 字符串 | 主机组元素的自定义标签. 对于具有自定义主机组标签类型的拓扑图是必需的. |
| label_string_image | 字符串 | 图像元素的自定义标签. 对于具有自定义图像标签类型的拓扑图是必需的. |
| label_string_map | 字符串 | 拓扑图元素的自定义标签. 对于具有自定义拓扑图标签类型的拓扑图是必需的. |
| label_string_trigger | 字符串 | 触发器元素的自定义标签. 对于具有自定义触发器标签类型的拓扑图是必需的. |
| label_type | 整数 | 映射元素标签类型. 参考值： 0 - 标签； 1 - IP 地址； 2 - （默认） 元素名称；< br>3 - 仅状态； 4 - 无. |
| label_type_host | 整数 | 主机元素的标签类型. 参考值： 0 - 标签； 1 - IP 地址； 2 - （默认） 元素名称； 3 - 仅状态； 4 - 无； 5 - 自定义. |
| label_type_hostgroup | 整数 | 主机组元素的标签类型. 参考值： 0 - 标签； 2 - （默认） 元素名称； 3 -仅状态； 4 - 无； 5 - 自定义. |
| label_type_image | 整数 | 主机组元素的标签类型. 参考值： 0 - 标签； 2 - （默认） 元素名称； 4 -什么都没有； 5 - 自定义. |
| label_type_map | 整数 | 拓扑图元素的标签类型. 参考值： 0 - 标签； 2 - （默认）元素名称； 3 - 状态仅； 4 - 无； 5 - 自定义. |
| label_type_trigger | 整数 | 触发器元素的标签类型. 参考值： 0 - 标签； 2 - （默认）元素名称； 3 - 状态仅； 4 - 无； 5 - 自定义. |
| markelements | 整数 | 是否突出显示最近更改状态的拓扑图元素. 参考值： 0 - （默认） 不突出显示元素； 1 - 突出显示元素. |
| severity_min | 整数 | 将在拓扑图上显示的触发器的最小严重性. 请参阅触发器“严重性”属性获取支持的触发器严重性列表. |
| show_unack | 整数 | 应该如何显示问题. 参考值： 0 - （默认） 显示所有问题的计数； 1 - 仅显示未确认的计数问题； 2 - 分别显示已确认和未确认问题的计数. |
| userid | string | 映射所有者用户 ID. |
| private | integer | 拓扑图共享的类型. 参考值： 0 - 公共拓扑图； 1 - （默认） 私人拓扑图. |
| show_suppressed | 整数 | 是否显示抑制的问题. 参考值： 0 - （默认） 隐藏抑制的问题； 1 - 显示抑制的问题. |
注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。
拓扑图元素
拓扑图元素对象定义了在拓扑图上显示的对象.它有以下属性.
| 属性 | 类型 | 说明 |
|---|---|---|
| selementid | string | (readonly) 拓扑图元素的 ID. |
| 元素 （必需） |
array | 元素数据对象.主机、主机组、触发器和映射类型元素是必需的. |
| elementtype （必需） |
integer | 拓扑图元素的类型. 参考值： 0 - 主机； 1 - 拓扑图； 2 - 触发器； 3 - 主机组； 4 - 图片. |
| iconid_off （必需） |
string | 用于在默认状态下显示元素的图像的 ID. |
| areatype | integer | 应如何显示单独的主机组主机. 参考值： 0 - （默认） 主机组元素将占据整个拓扑图； 1 -主机组元素将具有固定大小. |
| elementsubtype | integer | 主机组元素应如何显示在拓扑图上. 参考值： 0 - （默认） 将主机组显示为单个元素； 1 - |
| evaltype | integer | 拓扑图元素标签过滤条件评估方法. 可用值： 0 - (默认) AND / OR; 2 - OR. |
| height | integer | 固定大小的主机组元素的高度，以像素为单位. 默认值：200. |
| iconid_disabled | string | 用于显示禁用拓扑图元素的图像 ID.未用于图像元素. |
| iconid_maintenance | string | 用于在维护中显示拓扑图元素的图像 ID.未用于图像元素. |
| iconid_on | string | 用于显示有问题的拓扑图元素的图像 ID.未用于图像元素. |
| label | string | 元素的标签. |
| label_location | integer | 拓扑图元素标签的位置. 参考值： -1 - （默认） 默认位置； 0 - 底部； 1 - 左侧; 2 - 右; 3 - 顶部. |
| permission | integer | 权限级别的类型. 参考值： -1 - 无； 2 - 只读； 3 - 读写. |
| sysmapid | string | (readonly) 元素所属映射的 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 | string | 主机 ID |
拓扑图元素中的主机组
拓扑图元素中的主机组对象定义是一个主机组元素.
| 属性 | 类型 | 说明 |
|---|---|---|
| groupid | string | 主机组 ID |
拓扑图元素中的拓扑图
拓扑图元素中的拓扑图对象默认是一个拓扑图元素
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmapid | string | 拓扑图 ID |
拓扑图元素中的触发器
拓扑图元素中的触发器对象定义的是一个或者多个触发器元素
| 属性 | 类型 | 说明 |
|---|---|---|
| triggerid | string | 触发器 ID |
拓扑图元素标签
拓扑图元素标签对象具有以下属性.
| 属性 | 类型 | 描述 |
|---|---|---|
| tag (required) |
string | 拓扑图元素标签名称。 |
| operator | string | 映射元素标记条件运算符 可选值: 0 - (默认) 包含; 1 - 等于; 2 - 不包含; 3 - 不等于; 4 - 存在; 5 - 不存在. |
| value | string | 拓扑图元素标签值。 |
拓扑图元素URL
拓扑图元素URL对象定义了一个可点击的链接,可用于拓扑图上特定类型的所有元素.它具有以下特性:
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmapurlid | string | (只读) 拓扑图URL ID |
| name (required) |
string | 链接标题. |
| url (required) |
string | 链接URL |
| elementtype | integer | 可以使用在URL上的拓扑图元素类型. 请参考 拓扑图元素"类型"属性 拓扑图元素可用URL类型 默认：0 |
| sysmapid | string | 所属URL的拓扑图ID |
拓扑图链接
拓扑图链接对象定义了两个拓扑图元素之间的链接.它有以下属性.
| 属性 | 类型 | 描述 |
|---|---|---|
| linkid | string | (readonly) 拓扑图链接的 ID. |
| selementid1 （必需） |
string | 连接在一端的第一个拓扑图元素的 ID. |
| selementid2 （必需） |
string | 连接到另一端的第一个拓扑图元素的 ID. |
| color | string | 作为十六进制颜色代码的线条颜色. 默认值： 000000. |
| drawtype | integer | 链接线绘制样式. 参考值： 0 - （默认） 线； 2 - 粗线； 3 - 虚线； 4 - 虚线. |
| label | string | 链接标签. |
| linktriggers | array | 拓扑图链接触发器用作链接状态指示器. 拓扑图链接触发器对象详细描述如下. |
| permission | integer | 权限级别的类型. 参考值： -1 - 无； 2 - 只读； 3 - 读写. |
| sysmapid | string | 链接所属拓扑图的ID. |
拓扑链接触发器
拓扑链接触发器根据触发器的状态定义了拓扑图链接状态指标,它具有以下属性:
| 属性 | 类型 | 描述 |
|---|---|---|
| linktriggerid | string | (readonly) 拓扑链接触发器的ID. |
| triggerid (reqiuired) |
string | 用于链接指标的触发器的ID. |
| color | string | Indicator 颜色作为十六进制颜色代码. 默认: DD0000. |
| drawtype | integer | 指标绘制风格. 参考值: 0 - (default) line; 2 - 粗线; 3 - 点虚线; 4 - 虚线. |
| linkid | string | 链接触发器所属的拓扑链接ID. |
拓扑图URL
拓扑图URL对象定义了一个可点击的链接,可用于映射上特定类型的所有元素.它具有以下特性:
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmapurlid | string | (只读) 拓扑图URL ID |
| name (required) |
string | 链接标题. |
| url (required) |
string | 链接URL |
| elementtype | integer | 可以使用在URL上的拓扑图元素类型. 请参考 拓扑图元素"类型"属性 拓扑图元素可用URL类型 默认：0 |
| sysmapid | string | 所属URL的拓扑图ID |
拓扑图用户
基于用户的拓扑图权限列表.它具有以下特性:
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmapuserid | string | (只读) 拓扑图用户ID |
| userid (必须) |
string | 用户 ID. |
| permission (必须) |
integer | 权限等级类型 参考值： 2 - 只读 3 - 可读可写 |
拓扑图用户组
基于用户组的拓扑图权限列表.它具有以下特性:
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmapusrgrpid | string | (只读) 拓扑图用户组的ID |
| usrgrpid (必须) |
string | 用户组 ID. |
| permission (必须) |
integer | 权限等级类型 参考值： 2 - 只读 3 - 可读可写 |
拓扑图形状
拓扑图形状对象定义了在拓扑图上显示的几何形状（有或没有文本）， 它具有以下属性
| 属性 | 类型 | 说明 |
|---|---|---|
| sysmap_shapeid | string | (只读) 拓扑图形状元素的 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 Default: 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 - 无； 1 - ————;2 - ··· ··;3 - - - -.默认值：0. |
| border_width | integer | 以像素为单位的边框宽度. 默认值：0. |
| border_color | string | 边框颜色. 默认值：'000000'. |
| background_color | string | 背景颜色（填充颜色）. 默认值： （空）. |
| zindex | integer | 用于对所有形状和线条进行排序的值 (z-index). 默认值：0. |
拓扑图线
该对象定义在拓扑图上显示的线.它有以下属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| sysmap_shapeid | string | (只读) 拓扑图形状元素的 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. |