第1页 / 共181页
第2页 / 共181页
第3页 / 共181页
第4页 / 共181页
第5页 / 共181页
第6页 / 共181页
第7页 / 共181页
第8页 / 共181页
Zabbix系统监控接口文档.docx
Zabbix系统接口文档
目录
1.获取API版本
2.关联（3.2版本开始有）
2.1.correlation.create
2.2.correlation.delete
2.3.correlation.get
2.4.correlation.update
3.监控项
3.1.item.create
3.2.item.delete
3.3.item.get
3.4.item.update
3.5.item.isreadable
3.6.item.iswritable
4.主机
4.1.host.create
4.2.host.delete
4.3.host.get
4.4.host.update
4.5.host.massadd
4.6.host.massremove
4.7.host.massupdate
4.8.host.isreadable
4.9.host.iswritable
5.主机组
5.1.hostgroup.create
5.2.hostgroup.delete
5.3.hostgroup.get
5.4.hostgroup.update
5.5.hostgroup.massadd
5.6.hostgroup.massremove
5.7.hostgroup.massupdate
5.8.hostgroup.isreadable
5.9.hostgroup.iswritable
6.Web场景
6.1.httptest.create
6.2.httptest.delete
6.3.httptest.get
6.4.httptest.update
6.5.httptest.isreadable
6.6.httptest.iswritable
7.模板
7.1.template.create
7.2.template.delete
7.3.template.get
7.4.template.update
7.5.template.massadd
7.6.template.massremove
7.7.template.massupdate
7.8.template.isreadable
7.9.template.iswritable
8.发现主机
8.1.dhost.get
9.发现服务
9.1.dservice.get
10.发现检查
10.1.dcheck.get
11.发现规则
11.1.drule.create
11.2.drule.delete
11.3.drule.get
11.4.drule.update
11.5.drule.isreadable
11.6.drule.iswritable
12.应用集
12.1.application.create
12.2.application.delete
12.3.application.get
12.4.application.update
12.5.application.massadd
13.触发器
13.1.trigger.create
13.2.trigger.delete
13.3.trigger.get
13.4.trigger.update
13.5.trigger.adddependencies
13.6.trigger.deletedependencies
13.7.trigger.isreadable
13.8.trigger.iswritable
14.图像
14.1.image.create
14.2.image.delete
14.3.image.get
14.4.image.update
15.聚合图形项目
15.1.screenitem.create
15.2.screenitem.delete
15.3.screenitem.get
15.4.screenitem.update
15.5.screenitem.updatebyposition
15.6.screenitem.isreadable
15.7.screenitem.iswritable
16.聚合图形
16.1.screen.create
16.2.screen.delete
16.3.screen.get
16.4.screen.update
17.图形项
17.1.graphitem.get
18.图形
18.1.graph.create
18.2.graph.delete
18.3.graph.get
18.4.graph.update
19.原型图
19.1.graphprototype.create
19.2.graphprototype.delete
19.3.graphprototype.get
19.4.graphprototype.update
20.模板聚合图形项
20.1.templatescreenitem.get
21.模板聚合图形
21.1.templatescreen.create
21.2.templatescreen.delete
21.3.templatescreen.get
21.4.templatescreen.update
21.5.templatescreen.copy
21.6.templatescreen.isreadable
21.7.templatescreen.iswritable
22.历史数据
22.1.history.get
23.用户
23.1.user.create
23.2.user.delete
23.3.user.get
23.4.user.update
23.5.user.updateprofile
23.6.user.addmedia
23.7.user.deletemedia
23.8.user.updatemedia
23.9.user.login
23.10.user.logout
23.11.user.isreadable
23.12.user.iswritable
24.用户组
24.1.usergroup.create
24.2.usergroup.delete
24.3.usergroup.get
24.4.usergroup.update
24.5.usergroup.massadd
24.6.usergroup.massupdate
24.7.usergroup.isreadable
24.8.usergroup.iswritable
25.用户宏
25.1.usermacro.create
25.2.usermacro.delete
25.3.usermacro.get
25.4.usermacro.update
25.5.usermacro.createglobal
25.6.usermacro.deleteglobal
25.7.usermacro.updateglobal
26.主机接口
26.1.hostinterface.create
26.2.hostinterface.delete
26.3.hostinterface.get
26.4.hostinterface.update
26.5.hostinterface.massadd
26.6.hostinterface.massremove
26.7.hostinterface.replacehostinterfaces
27.主机原型
27.1.hostprototype.create
27.2.hostprototype.delete
27.3.hostprototype.get
27.4.hostprototype.update
27.5.hostprototype.isreadable
27.6.hostprototype.iswritable
28.LLD规则
28.1.discoveryrule.copy
28.2.discoveryrule.create
28.3.discoveryrule.delete
28.4.discoveryrule.get
28.5.discoveryrule.update
28.6.discoveryrule.isreadable
28.7.discoveryrule.iswritable
Zabbix 接口说明—向功涛
Zabbix 系统接口文档
（V1.0）
向功涛
2018.3
Zabbix 接口说明—向功涛
目录
Zabbix 系统接口文档 .................................................................................................................... - 1 -
目录 ................................................................................................................................................ - 2 -
1. 获取 API 版本............................................................................................................................- 1 -
2. 关联（3.2 版本开始有） .........................................................................................................- 1 -
2.1. correlation.create ............................................................................................................- 1 -
2.2. correlation.delete............................................................................................................- 4 -
2.3. correlation.get................................................................................................................. - 5 -
2.4. correlation.update ...........................................................................................................- 6 -
3. 监控项....................................................................................................................................... - 8 -
3.1. item.create.......................................................................................................................- 8 -
3.2. item.delete .................................................................................................................... - 10 -
3.3. item.get ......................................................................................................................... - 10 -
3.4. item.update................................................................................................................... - 16 -
3.5. item.isreadable ..............................................................................................................- 17 -
3.6. item.iswritable ...............................................................................................................- 18 -
4. 主机 ......................................................................................................................................... - 18 -
4.1. host.create.....................................................................................................................- 18 -
4.2. host.delete .....................................................................................................................- 20 -
4.3. host.get ..........................................................................................................................- 21 -
4.4. host.update................................................................................................................... - 28 -
4.5. host.massadd.................................................................................................................- 31 -
4.6. host.massremove.......................................................................................................... - 32 -
4.7. host.massupdate........................................................................................................... - 33 -
4.8. host.isreadable .............................................................................................................. - 34 -
4.9. host.iswritable ............................................................................................................... - 34 -
5. 主机组..................................................................................................................................... - 35 -
5.1. hostgroup.create........................................................................................................... - 35 -
5.2. hostgroup.delete ........................................................................................................... - 36 -
5.3. hostgroup.get................................................................................................................ - 37 -
5.4. hostgroup.update..........................................................................................................- 38 -
5.5. hostgroup.massadd.......................................................................................................- 39 -
5.6. hostgroup.massremove .................................................................................................- 40 -
5.7. hostgroup.massupdate ..................................................................................................- 41 -
5.8. hostgroup.isreadable .....................................................................................................- 42 -
5.9. hostgroup.iswritable..................................................................................................... - 42 -
6. Web 场景 ..................................................................................................................................- 43 -
6.1. httptest.create...............................................................................................................- 43 -
6.2. httptest.delete...............................................................................................................- 44 -
6.3. httptest.get ....................................................................................................................- 45 -
6.4. httptest.update..............................................................................................................- 48 -
6.5. httptest.isreadable ........................................................................................................ - 49 -
Zabbix 接口说明—向功涛
6.6. httptest.iswritable ......................................................................................................... - 49 -
7. 模板 ......................................................................................................................................... - 50 -
7.1. template.create............................................................................................................. - 50 -
7.2. template.delete .............................................................................................................- 51 -
7.3. template.get .................................................................................................................. - 52 -
7.4. template.update............................................................................................................- 55 -
7.5. template.massadd.........................................................................................................- 55 -
7.6. template.massremove...................................................................................................- 57 -
7.7. template.massupdate....................................................................................................- 59 -
7.8. template.isreadable ...................................................................................................... - 60 -
7.9. template.iswritable ....................................................................................................... - 60 -
8. 发现主机 ................................................................................................................................. - 61 -
8.1. dhost.get ........................................................................................................................- 61 -
9. 发现服务 ................................................................................................................................. - 65 -
9.1. dservice.get................................................................................................................... - 65 -
10. 发现检查 ............................................................................................................................... - 66 -
10.1. dcheck.get ................................................................................................................... - 66 -
11. 发现规则 ............................................................................................................................... - 68 -
11.1. drule.create................................................................................................................. - 68 -
11.2. drule.delete................................................................................................................. - 69 -
11.3. drule.get ...................................................................................................................... - 70 -
11.4. drule.update................................................................................................................- 72 -
11.5. drule.isreadable...........................................................................................................- 73 -
11.6. drule.iswritable............................................................................................................- 74 -
12. 应用集................................................................................................................................... - 74 -
12.1. application.create........................................................................................................- 74 -
12.2. application.delete........................................................................................................- 75 -
12.3. application.get.............................................................................................................- 76 -
12.4. application.update...................................................................................................... - 77 -
12.5. application.massadd....................................................................................................- 78 -
13. 触发器................................................................................................................................... - 79 -
13.1. trigger.create............................................................................................................... - 79 -
13.2. trigger.delete............................................................................................................... - 80 -
13.3. trigger.get.................................................................................................................... - 81 -
13.4. trigger.update.............................................................................................................. - 85 -
13.5. trigger.adddependencies .............................................................................................- 85 -
13.6. trigger.deletedependencies........................................................................................ - 86 -
13.7. trigger.isreadable.........................................................................................................- 87 -
13.8. trigger.iswritable..........................................................................................................- 88 -
14. 图像 ....................................................................................................................................... - 89 -
14.1. image.create................................................................................................................- 89 -
14.2. image.delete................................................................................................................- 90 -
14.3. image.get .....................................................................................................................- 91 -
14.4. image.update...............................................................................................................- 92 -
Zabbix 接口说明—向功涛
15. 聚合图形项目 .......................................................................................................................- 93 -
15.1. screenitem.create........................................................................................................- 93 -
15.2. screenitem.delete ........................................................................................................- 95 -
15.3. screenitem.get.............................................................................................................- 95 -
15.4. screenitem.update.................................................................................................... - 100 -
15.5. screenitem.updatebyposition................................................................................... - 100 -
15.6. screenitem.isreadable ...............................................................................................- 101 -
15.7. screenitem.iswritable................................................................................................- 102 -
16. 聚合图形 .............................................................................................................................- 103 -
16.1. screen.create............................................................................................................. - 103 -
16.2. screen.delete.............................................................................................................- 105 -
16.3. screen.get.................................................................................................................. - 106 -
16.4. screen.update............................................................................................................- 108 -
17. 图形项................................................................................................................................. - 110 -
17.1. graphitem.get............................................................................................................- 110 -
18. 图形 ..................................................................................................................................... - 112 -
18.1. graph.create.............................................................................................................. - 112 -
18.2. graph.delete.............................................................................................................. - 113 -
18.3. graph.get................................................................................................................... - 114 -
18.4. graph.update ............................................................................................................. - 117 -
19. 原型图................................................................................................................................. - 118 -
19.1. graphprototype.create.............................................................................................. - 118 -
19.2. graphprototype.delete..............................................................................................- 119 -
19.3. graphprototype.get ................................................................................................... - 120 -
19.4. graphprototype.update.............................................................................................- 122 -
20. 模板聚合图形项.................................................................................................................- 122 -
20.1. templatescreenitem.get............................................................................................- 122 -
21. 模板聚合图形 .....................................................................................................................- 125 -
21.1. templatescreen.create.............................................................................................. - 125 -
21.2. templatescreen.delete .............................................................................................. - 126 -
21.3. templatescreen.get................................................................................................... - 127 -
21.4. templatescreen.update.............................................................................................- 130 -
21.5. templatescreen.copy.................................................................................................- 130 -
21.6. templatescreen.isreadable ........................................................................................- 131 -
21.7. templatescreen.iswritable.........................................................................................- 132 -
22. 历史数据 .............................................................................................................................- 132 -
22.1. history.get..................................................................................................................- 132 -
23. 用户 ..................................................................................................................................... - 135 -
23.1. user.create................................................................................................................. - 135 -
23.2. user.delete.................................................................................................................- 136 -
23.3. user.get...................................................................................................................... - 137 -
23.4. user.update................................................................................................................- 139 -
23.5. user.updateprofile..................................................................................................... - 140 -
23.6. user.addmedia...........................................................................................................- 140 -
Zabbix 接口说明—向功涛
23.7. user.deletemedia.......................................................................................................- 141 -
23.8. user.updatemedia......................................................................................................- 142 -
23.9. user.login................................................................................................................... - 143 -
23.10. user.logout...............................................................................................................- 145 -
23.11. user.isreadable........................................................................................................ - 146 -
23.12. user.iswritable......................................................................................................... - 146 -
24. 用户组................................................................................................................................. - 147 -
24.1. usergroup.create....................................................................................................... - 147 -
24.2. usergroup.delete ....................................................................................................... - 148 -
24.3. usergroup.get............................................................................................................ - 149 -
24.4. usergroup.update......................................................................................................- 151 -
24.5. usergroup.massadd...................................................................................................- 152 -
24.6. usergroup.massupdate..............................................................................................- 153 -
24.7. usergroup.isreadable.................................................................................................- 154 -
24.8. usergroup.iswritable................................................................................................. - 154 -
25. 用户宏................................................................................................................................. - 155 -
25.1. usermacro.create...................................................................................................... - 155 -
25.2. usermacro.delete...................................................................................................... - 156 -
25.3. usermacro.get ........................................................................................................... - 157 -
25.4. usermacro.update..................................................................................................... - 158 -
25.5. usermacro.createglobal............................................................................................ - 159 -
25.6. usermacro.deleteglobal............................................................................................ - 160 -
25.7. usermacro.updateglobal........................................................................................... - 161 -
26. 主机接口 .............................................................................................................................- 161 -
26.1. hostinterface.create.................................................................................................. - 161 -
26.2. hostinterface.delete.................................................................................................. - 163 -
26.3. hostinterface.get....................................................................................................... - 163 -
26.4. hostinterface.update.................................................................................................- 165 -
26.5. hostinterface.massadd ..............................................................................................- 166 -
26.6. hostinterface.massremove........................................................................................- 167 -
26.7. hostinterface.replacehostinterfaces......................................................................... - 168 -
27. 主机原型 .............................................................................................................................- 169 -
27.1. hostprototype.create................................................................................................ - 169 -
27.2. hostprototype.delete................................................................................................ - 170 -
27.3. hostprototype.get..................................................................................................... - 171 -
27.4. hostprototype.update...............................................................................................- 173 -
27.5. hostprototype.isreadable ..........................................................................................- 173 -
27.6. hostprototype.iswritable...........................................................................................- 174 -
28. LLD 规则（待写。。。）................................................................................................... - 175 -
28.1. discoveryrule.copy.................................................................................................... - 175 -
28.2. discoveryrule.create..................................................................................................- 175 -
28.3. discoveryrule.delete ..................................................................................................- 175 -
28.4. discoveryrule.get .......................................................................................................- 175 -
28.5. discoveryrule.update.................................................................................................- 175 -
Zabbix 接口说明—向功涛
28.6. discoveryrule.isreadable........................................................................................... - 175 -
28.7. discoveryrule.iswritable ............................................................................................ - 175 -
29. 应用集（待写。。。） ...........................................................................错误！未定义书签。
29.1. application.create............................................................................错误！未定义书签。
29.2. application.delete............................................................................错误！未定义书签。
29.3. application.get.................................................................................错误！未定义书签。
29.4. application.update.......................................................................... 错误！未定义书签。
29.5. application.massadd....................................................................... 错误！未定义书签。
Zabbix 接口说明—向功涛
1. 获取 API 版本
Description 该方法用于获取 Zabbix API 版本
请求方法
URL
Content-Type
Request
POST
http://192.168.3.132/zabbix/api_jsonrpc.php
application/json
{
"jsonrpc": "2.0",
//这是标准的 JSON RPC 参数以标示协议
版本。所有的请求都会保持不变
"method": "apiinfo.version", //这个参数定义了真实执行的
操作。例如：host.create、item.update 等等
"params": [], //请求的参数列表,采用键值对形式
"id": 1
//用于绑定 JSON 请求和响应.响应会跟请求有相同的
"id"。在一次性发送多个请求时很有用，这些也不需要唯一或者连续
}
返回值
Response
返回 Zabbix API 的版本
{
"jsonrpc": "2.0",
"result": "3.0.14",
"id": 1
}
2. 关联（3.2 版本开始有）
2.1. correlation.create
Description 该方法允许创建新的关联
请求方法
URL
Content-Type
Request
POST
http://192.168.3.132/zabbix/api_jsonrpc.php
application/json
示例一：
创建一个新的事件标签关联
{
"jsonrpc": "2.0",
"method": "correlation.create",
"params": { //这里通过传递 JSON 对象来作为特定方法的参数。
- 1 -
Zabbix 接口说明—向功涛
如果你希望创建监控项，"name"和"key_"参数是需要的，每个方法需要的
参数在 Zabbix API 文档中都有描述。
"name": "new event tag correlation",//关联的名称
(required)
"filter": {
//关联的关联过滤对象(required)
"evaltype": 0, //过滤条件评估方法。(required)
//0 - and/or;1 - and;2 - or;3 - custom expression.
"conditions": [ //用于过滤结果的一组过滤条件
(required)
{
}
"type": 1,//条件类型.可能的值：(required)
//0 - 旧事件标签
//1 - 新事件标签
//2 - 新事件主机组;
//3 - 事件标签对
//4 - 旧事件标签值;
//5 - 新的事件标签值
"tag": "ok"
},
"auth": "343baad4f88b4106b9b5961e77437688",
//这是一
个认证令牌【authentication token】用以鉴别用户、访问 API。这也是
使用 API 进行相关操作的前提-获取认证 ID
"id": 1
//这个字段用于绑定 JSON 请求和响应。响应会跟请求
有相同的"id"。在一次性发送多个请求时很有用，这些也不需要唯一或者
连续
}
实例二：
创建一个使用自定义过滤条件的关联。公式 ID“A”或“B”已被任意选
择。条件类型将为“主机组”与操作员
{
"jsonrpc": "2.0",
"method": "correlation.create",
"params": {
"name": "new host group correlation", //(required)
- 2 -
},
"operations": [
"type": 0
//创建关联的关联操作(required)
//操作类型.可能的值是：(required)
//0 - 关闭旧事件 ;1 - 关闭新事件
]
{
}
]
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
