获取

描述

integer/array iconmap.get(object **parameters**)

此方法允许根据指定的参数获取图标拓扑图.

参数

(对象) 定义要输出的参数.

该方法支持以下参数:

参数类型描述
iconmapids字符串/数组返回指定ID的图标拓扑图.
sysmapids字符串/数组返回在指定拓扑图中使用的图标拓扑图.
selectMappings查询返回在mappings属性中使用的图标映射.
sortfield字符串/数组根据指定的属性将结果排序.

可能的值: iconmapid 和 name.
countOutput布尔值这些参数对于所有get方法都是通用的，详情可参考reference commentary.
editable布尔值
excludeSearch布尔值
filter对象
limitinteger
output查询
preservekeys布尔值
search对象
searchByAny布尔值
searchWildcardsEnabled布尔值
sortorder字符串/数组
startSearch布尔值

返回值

(整数/数组) 返回:

  • 一组对象;

  • 如果设置了countOutput参数,则返回对象数量.

示例

获取一个图标拓扑图

获取所有关于ID为3的图标拓扑图数据.

请求:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "iconmap.get",
  4.     "params": {
  5.         "iconmapids": "3",
  6.         "output": "extend",
  7.         "selectMappings": "extend"
  8.     },
  9.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10.     "id": 1
  11. }

响应:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "mappings": [
  6.                 {
  7.                     "iconmappingid": "3",
  8.                     "iconmapid": "3",
  9.                     "iconid": "6",
  10.                     "inventory_link": "1",
  11.                     "expression": "server",
  12.                     "sortorder": "0"
  13.                 },
  14.                 {
  15.                     "iconmappingid": "4",
  16.                     "iconmapid": "3",
  17.                     "iconid": "10",
  18.                     "inventory_link": "1",
  19.                     "expression": "switch",
  20.                     "sortorder": "1"
  21.                 }
  22.             ],
  23.             "iconmapid": "3",
  24.             "name": "Host type icons",
  25.             "default_iconid": "2"
  26.         }
  27.     ],
  28.     "id": 1
  29. }

参考

来源

CIconMap::get() in frontends/php/include/classes/api/services/CIconMap.php.