Documentation
Table of Contents
map.get
Leírás
integer/array map.get(objektumparaméterek)
A módszer lehetővé teszi a térképek lekérését a megadott paraméterek szerint.
Ez a módszer bármilyen típusú felhasználó számára elérhető. Engedélyek A metódus meghívása a felhasználói szerepkör beállításaiban visszavonható. Lásd: User roles további információért.
Paraméterek
(object) A kívánt kimenetet meghatározó paraméterek.
A módszer a következő paramétereket támogatja.
| Paraméter | Típus | Leírás |
|---|---|---|
| sysmapids | string/array | Csak a megadott azonosítókkal rendelkező térképeket adja vissza. |
| userids | string/array | Csak azokat a térképeket adja vissza, amelyek az adott felhasználói azonosítókhoz tartoznak. |
| expandUrls | flag | Hozzáadja a globális térkép URL-címeit a megfelelő térképelemekhez, és kibontja a makrókat az összes térképelem URL-címében. |
| selectIconMap | query | Egy iconmap tulajdonságot ad vissza a térképen használt ikontérképpel. |
| selectLinks | query | Egy links tulajdonságot ad vissza az elemek közötti leképezési hivatkozásokkal. |
| selectSelements | query | Egy selements tulajdonságot ad vissza a térképelemekkel. |
| selectUrls | query | Egy urls tulajdonságot ad vissza a térkép URL-jeivel. |
| selectUsers | query | Egy users tulajdonságot ad vissza olyan felhasználókkal, akikkel a térkép meg van osztva. |
| selectUserGroups | query | Egy userGroups tulajdonságot ad vissza olyan felhasználói csoportokkal, amelyekkel a térkép meg van osztva. |
| selectShapes | query | Egy shapes tulajdonságot ad vissza a térképalakzatokkal. |
| selectLines | query | Egy lines tulajdonságot ad vissza a térképvonalakkal együtt. |
| sortfield | string/array | Rendezd az eredményt a megadott tulajdonságok szerint. A lehetséges értékek: name, width és height. |
| countOutput | boolean | Ezek a paraméterek, amelyek minden get metódusnál közösek, a referenciakommentár részben találhatók. |
| szerkeszthető | logikai | |
| excludeSearch | logikai | |
| szűrő | objektum | |
| korlát | egész szám | |
| kimenet | lekérdezés | |
| preservekeys | boolean | |
| kereső | objektum | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | karakterlánc/tömb | |
| startSearch | boolean |
Visszatérési értékek
(integer/array) A következőket adja vissza:
- objektumok tömbje;
- a letöltött objektumok száma, ha a
countOutputparamétert használták.
Példák
Retrieve a map
Retrieve all data about map "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 network",
"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
}Lásd még
- Ikontérkép
- Térképelem
- Térképlink
- Térkép URL
- Térképfelhasználó
- Térkép felhasználói csoport
- Térkép alakzatok
- Térképvonalak
Forrás
CMap::get() az ui/include/classes/api/services/CMap.php-ban.