一.什么是API?
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。简单的说,API就是对外的接口,利用API可以直接到达软件硬件内部来进行操作。
zabbix中API的作用:
Zabbix API为批量操作、第三方软件集成以及其他作用提供可编程接口。
API的大致工作流如下:
(1)API 采用JSON-RPC实现。这意味着调用任何函数,都需要发送POST请求,输入输出数据都是以JSON格式
(2)准备JSON对象,它描述了你想要做什么(创建主机,获取图像,更新监控项等)。
(3)获取JSON格式响应。
在做实验前,把zabbix监控的自动发现和自动注册的相应配置都关掉(如果没有添加过则不用配置)
二.查看监控的主机
1.编写脚本: 查看zabbix监控系统的api接口
vim zabbix-api
curl -s -XPOST -H "Content-Type: application/json-rpc" -d ' ##利用curl命令模拟json格式的post请求
{
"jsonrpc": "2.0", ##这是标准的JSON RPC参数以标示协议版本。所有的请求都会保持不变
"method": "user.login", ##利用用户登陆的方式获取API
"params": {
"user": "Admin", ##zabbix监控系统的用户名和密码
"password": "zabbix"
},
"id": 1, ##这个字段用于绑定JSON请求和响应。响应会跟请求有相同的"id"。在一次性发送多个请求时很有用,这些也不需要唯一或者连续
"auth": null
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool
##采用POST方法向http://example.com/zabbix/api_jsonrpc.php发送此JSON对象. http://example.com/zabbix/是Zabbix前端地址。
##api_jsonrpc.php是调用API的PHP脚本。可在安装可视化前端的目录下找到。
2.给脚本以执行权限
chmod +x zabbix-api
./zabbix-api
{
"id": 1,
"jsonrpc": "2.0",
"result": "759b11d8a4ebf1764774e145fbe8cfce" ##获得# zabbix监控的API(令牌) }
3.查看Zabbix主机和被监控主机的信息
vim zabbix-api
curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"hostid",
"host"
],
"selectInterfaces": [
"interfaceid",
"ip"
]
},
"id":2,
"auth": "759b11d8a4ebf1764774e145fbe8cfce" ##此处是zabbix的API令牌
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool
4.执行脚本
./zabbix-api
5.测试的结果如下图
三.删除监控的主机
1.编写相应的API脚本
vim zabbix-api
curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
"jsonrpc": "2.0",
"method": "host.delete", ##调用host.delete方法
"params": [
"10269" ##上一步返回的被监控主机hostid号,表示用脚本删除这个监控的主机
],
"id":2,
"auth": "759b11d8a4ebf1764774e145fbe8cfce"
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool
2.执行脚本
./zabbix-api
{
"id": 2,
"jsonrpc": "2.0",
"result": {
"hostids": [
"10269" ##表示上面执行脚本已完成,将hostid为设定的监控主机删除。
]
}
}
3.在浏览器的zabbix的web界面上,刷新查看:发现server2已经被删除了
四.添加监控的主机
1.编写相应的zabbix的API脚本
vim zabbix-api
curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
"jsonrpc": "2.0",
"method": "host.create", # 调用host.create方法
"params": {
"host": "server2", # 被监控的主机名
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "172.25.19.2", # 被监控主机的ip
"dns": "",
"port": "10050" # zabbix-agent的端口号
}
],
"groups": [
{
"groupid": "2" # 建立的主机加入的群组id
}
],
"templates": [
{
"templateid": "10001" # 建立的主机使用的模版id
}
]
},
"id":2,
"auth": "759b11d8a4ebf1764774e145fbe8cfce"
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool
2.执行脚本 ./zabbix-api
./zabbix-api
{
"id": 2,
"jsonrpc": "2.0",
"result": {
"hostids": [
"10270"
]
}
}
3.在浏览器的zabbix的web界面上,刷新查看:发现server2被再次添加,添加成功。
五.如何获知相应的groupid和templateid呢?
我们可以在zabbix的web界面中打开某个群组和模版,即可在上边的地址栏中得到