一、API概览
Zabbix API允许你以编程方式检索和修改Zabbix的配置,并提供对历史数据的访问。它广泛用于:
-
创建新的应用程序以使用Zabbix;
-
将Zabbix与第三方软件集成;
-
自动执行常规任务。
Zabbix API是基于Web的API,作为Web前端的一部分提供。它使用JSON-RPC 2.0协议,这意味着两件事:
-
该API包含一组独立的方法;
-
客户端和API之间的请求和响应使用JSON格式进行编码
二、API示例应用
1.验证
在访问Zabbix中的任何数据之前,你需要登录并获取身份验证令牌。这可以使用该 user.login
方法完成。让我们假设你想要以标准Zabbix Admin用户身份登录
[root@node1 ~]# vim zabbix-api
curl -XPOST -H "Content-Type: application/json-rpc" -d' #curl默认的http动词是get,使用X可以支持其他动词,启用curl模拟json的post请求
{
"jsonrpc": "2.0", #标准的JSON
"method": "user.login",
"params": {
"user": "Admin",
"password": "zabbix"
},
"id": 1,
"auth": null #用户的身份令牌,因为还没有获取,所以为null
}' http://172.25.7.1/zabbix/api_jsonrpc.php
[root@node1 ~]# chmod +x zabbix-api
2.检索主机
使用hostget 方法获取主机名,ip,id,及接口
[root@node1 ~]# vim zabbix-api
curl -XPOST -H "Content-Type: application/json-rpc" -d'
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"hostid",
"host"
],
"selectInterfaces": [
"interfaceid",
"ip"
]
},
"id": 2,
"auth": "cd501b4f1204440e7924818d2da7cf89" #上一步获取的身份指令
}' http://172.25.7.1/zabbix/api_jsonrpc.php | python -m json.tool
结果
3.删除监控中的主机,可以看到node2原来是在监控之中的,现在通过AIP方式,将node2删除。
[root@node1 ~]# vim zabbix-api
curl -s XPOST -H "Content-Type: application/json-rpc" -d'
{
"jsonrpc": "2.0",
"method": "host.delete",
"params": [
"10309"
],
"id": 2,
"auth": "cd501b4f1204440e7924818d2da7cf89"
}' http://172.25.7.1/zabbix/api_jsonrpc.php | python -m json.tool
执行结果:
再次去浏览器查看:node2已被删除
4.创建监控主机
curl -s XPOST -H "Content-Type: application/json-rpc" -d'
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "node2", #要添加的主机名
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "172.25.7.2", #要添加的主机ip
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "10"
}
],
"templates": [
{
"templateid": "10001"
}
],
"inventory_mode": 0,
"inventory": {
"macaddress_a": "01234",
"macaddress_b": "56768"
}
},
"auth": "f3b4ad73d68bfffa0d25b3a010f4a952", #新生成的用户身份信息
"id": 1
}' http://172.25.7.1/zabbix/api_jsonrpc.php | python -m json.tool