Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

map.get

説明

integer/array map.get(object parameters)

このメソッドで、指定されたパラメーターに従ってマップを取得できます。

このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。

パラメータ

(object) 目的の出力を定義するパラメーター。

このメソッドは、次のパラメーターをサポートします。

パラメータ タイプ 説明
sysmapids string/array 指定されたIDのマップのみを返します
userids string/array 指定されたユーザーIDに属するマップのみを返します
expandUrls flag 対応するマップ要素にグローバルマップURLを追加し、すべてのマップ要素URLのマクロを展開します
selectIconMap query マップで使用されているアイコンマップを含むiconmapプロパティを返します。
selectLinks query 要素間のマップリンクを含むlinksプロパティを返します。
selectSelements query マップ要素とともにselementsプロパティを返します。
selectUrls query マップURLを含むurlsプロパティを返します。
selectUsers query マップが共有されているユーザーのusersプロパティを返します。
selectUserGroups query マップが共有されているユーザーグループを持つuserGroupsプロパティを返します。
selectShapes query マップシェイプとともにshapesプロパティを返します。
selectLines query マップラインとともにlinesプロパティを返します。
sortfield string/array 指定されたプロパティで結果を並べ替えます。

利用可能な値はname,width,heightです。
countOutput boolean すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメータが使用されている場合、取得されたオブジェクトの数

マップを取得する

マップ"3"に関するすべてのデータを取得します。

Request:

{
           "jsonrpc": "2.0",
           "method": "map.get",
           "params": {
               "output": "extend",
               "selectSelements": "extend",
               "selectLinks": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "selectShapes": "extend",
               "selectLines": "extend",
               "sysmapids": "3"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "selements": [
                       {
                           "selementid": "10",
                           "sysmapid": "3",
                           "elementtype": "4",
                           "evaltype": "0",
                           "iconid_off": "1",
                           "iconid_on": "0",
                           "label": "Zabbix server",
                           "label_location": "3",
                           "x": "11",
                           "y": "141",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "tags": [
                               {
                                   "tag": "service",
                                   "value": "mysqld",
                                   "operator": "0"
                               }
                           ],
                           "viewtype": "0",
                           "use_iconmap": "1",
                           "urls": [],
                           "elements": []
                       },
                       {
                           "selementid": "11",
                           "sysmapid": "3",
                           "elementtype": "4",
                           "evaltype": "0",
                           "iconid_off": "1",
                           "iconid_on": "0",
                           "label": "Web server",
                           "label_location": "3",
                           "x": "211",
                           "y": "191",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "1",
                           "tags": [],
                           "urls": [],
                           "elements": []
                       },
                       {
                           "selementid": "12",
                           "sysmapid": "3",
                           "elementtype": "0",
                           "evaltype": "0",
                           "iconid_off": "185",
                           "iconid_on": "0",
                           "label": "{HOST.NAME}\r\n{HOST.CONN}",
                           "label_location": "0",
                           "x": "111",
                           "y": "61",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "0",
                           "tags": [],
                           "urls": [],
                           "elements": [
                               {
                                   "hostid": "10084"
                               }
                           ]
                       }
                   ],
                   "links": [
                       {
                           "linkid": "23",
                           "sysmapid": "3",
                           "selementid1": "10",
                           "selementid2": "11",
                           "drawtype": "0",
                           "color": "00CC00",
                           "label": "",
                           "linktriggers": []
                       }
                   ],
                   "users": [
                       {
                           "sysmapuserid": "1",
                           "userid": "2",
                           "permission": "2"
                       }
                   ],
                   "userGroups": [
                       {
                           "sysmapusrgrpid": "1",
                           "usrgrpid": "7",
                           "permission": "2"
                       }
                   ],
                   "shapes":[  
                       {  
                           "sysmap_shapeid":"1",
                           "type":"0",
                           "x":"0",
                           "y":"0",
                           "width":"680",
                           "height":"15",
                           "text":"{MAP.NAME}",
                           "font":"9",
                           "font_size":"11",
                           "font_color":"000000",
                           "text_halign":"0",
                           "text_valign":"0",
                           "border_type":"0",
                           "border_width":"0",
                           "border_color":"000000",
                           "background_color":"",
                           "zindex":"0"
                       }
                   ],
                   "lines":[
                       {
                           "sysmap_shapeid":"2",
                           "x1": 30,
                           "y1": 10,
                           "x2": 100,
                           "y2": 50,
                           "line_type": 1,
                           "line_width": 10,
                           "line_color": "009900",
                           "zindex":"1"
                       }
                   ],
                   "sysmapid": "3",
                   "name": "Local nerwork",
                   "width": "400",
                   "height": "400",
                   "backgroundid": "0",
                   "label_type": "2",
                   "label_location": "3",
                   "highlight": "1",
                   "expandproblem": "1",
                   "markelements": "0",
                   "show_unack": "0",
                   "grid_size": "50",
                   "grid_show": "1",
                   "grid_align": "1",
                   "label_format": "0",
                   "label_type_host": "2",
                   "label_type_hostgroup": "2",
                   "label_type_trigger": "2",
                   "label_type_map": "2",
                   "label_type_image": "2",
                   "label_string_host": "",
                   "label_string_hostgroup": "",
                   "label_string_trigger": "",
                   "label_string_map": "",
                   "label_string_image": "",
                   "iconmapid": "0",
                   "expand_macros": "0",
                   "severity_min": "0",
                   "userid": "1",
                   "private": "1",
                   "show_suppressed": "1"
               }
           ],
           "id": 1
       }

参照

ソース

CMap::get() in ui/include/classes/api/services/CMap.php.