map.create
説明
object map.create(object/array maps)
このメソッドでは、新しいマップを作成できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。詳細については、ユーザーロールを参照してください。
パラメータ
(object/array) 作成するマップの対応付けです。
このメソッドは、標準のマッププロパティに加えて、 以下のパラメータを受け付けます。
| パラメータ | Type | 説明 |
|---|---|---|
| links | array | マップ上に作成するマップリンク。 |
| selements | array | マップ上に作成するマップ要素。 |
| urls | array | マップ上に作成するマップURL。 |
| users | array | マップ上に作成するマップユーザー共有。 |
| userGroups | array | マップ上に作成するマップユーザーグループ共有。 |
| shapes | array | マップ上に作成するマップ図形。 |
| lines | array | マップ上に作成するマップ線。 |
マップリンクを作成するには、マップ要素の
selementid に任意の値を設定し、その後この値を使用して、
リンクの selementid1 または selementid2 プロパティで
この要素を参照する必要があります。
要素が作成されると、この値は Zabbix によって生成された
正しいIDに置き換えられます。例を参照してください。
戻り値
(object) sysmapidsプロパティの下で作成されたマップのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたマップの順序と一致します。
例
空のマップを作成する
要素のないマップを作成します。
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map",
"width": 600,
"height": 600
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"8"
]
},
"id": 1
}
ホストマップの作成
2つのホスト要素と、それらの間のリンクを持つマップを作成します。マップリンク オブジェクトでマップ要素を参照するために、一時的な "selementid1" および "selementid2" の値が 使用されていることに注意してください。
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Host map",
"width": 600,
"height": 600,
"selements": [
{
"selementid": "1",
"elements": [
{"hostid": "1033"}
],
"elementtype": 0,
"iconid_off": "2"
},
{
"selementid": "2",
"elements": [
{"hostid": "1037"}
],
"elementtype": 0,
"iconid_off": "2"
}
],
"links": [
{
"selementid1": "1",
"selementid2": "2"
}
]
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 1
}
トリガーマップの作成
2つのトリガーを含むトリガー要素を持つマップを作成します。
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Trigger map",
"width": 600,
"height": 600,
"selements": [
{
"elements": [
{"triggerid": "12345"},
{"triggerid": "67890"}
],
"elementtype": 2,
"iconid_off": "2"
}
]
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"10"
]
},
"id": 1
}
マップの共有
2種類の共有(ユーザーおよびユーザーグループ)を持つマップを作成します。
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "マップの共有",
"width": 600,
"height": 600,
"users": [
{
"userid": "4",
"permission": "3"
}
],
"userGroups": [
{
"usrgrpid": "7",
"permission": "2"
}
]
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"9"
]
},
"id": 1
}
マップ図形
マップ名のタイトルを持つマップを作成します。
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Host map",
"width": 600,
"height": 600,
"shapes": [
{
"type": 0,
"x": 0,
"y": 0,
"width": 600,
"height": 11,
"text": "{MAP.NAME}"
}
]
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"10"
]
},
"id": 1
}
マップの線
マップの線を作成します。
{
"jsonrpc": "2.0",
"method": "map.create",
"params": {
"name": "Map API lines",
"width": 500,
"height": 500,
"lines": [
{
"x1": 30,
"y1": 10,
"x2": 100,
"y2": 50,
"line_type": 1,
"line_width": 10,
"line_color": "009900"
}
]
},
"id": 1
}
レスポンス:
{
"jsonrpc": "2.0",
"result": {
"sysmapids": [
"11"
]
},
"id": 1
}
関連項目
ソース
CMap::create() in ui/include/classes/api/services/CMap.php.