分布式系统监控软件zabbix——结合API进行检索、删除、创建主机
1.什么是API ?
API ( Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
Zabbix API允许你以编程方式检索和修改Zabbix的配置,并提供对历史数据的访问。它广泛用于:
- 创建新的应用程序以使用Zabbix;
- 将Zabbix与第三方软件集成;
- 自动执行常规任务。
Zabbix API是基于Web的API,作为Web前端的一部分提供。它使用JSON-RPC 2.0协议,这意味着两件事:
- 该API包含一组独立的方法;
- 客户端和API之间的请求和响应使用JSON格式进行编码。
2.结构
Zabbix API由许多名义上分组的独立API方法组成。每个方法执行一个特定任务。例如,方法 host.create 隶属于 host 这个API分组 ,用于创建新主机。历史上,API分组有时被称为“类”。
大多数API至少包含四种方法: get, create, update 和 delete ,分别是检索,创建,更新和删除数据,但是某些API提供一套完全不同的一组方法。
3.验证
在访问Zabbix中的任何数据之前,你需要登录并获取身份验证令牌。这可以使用该user.login 方法完成。让我们假设你想要以标准Zabbix Admin用户身份登录。
JSON请求如下所示:(注意:以下所有的请求内容都不能带注释,否则会报错)
vim zabbix-api
curl -XPOST -H "Content-Type: application/json-rpc" -d ' #利用curl命令模拟json格式的post请求
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin", #zabbix监控系统的用户名和密码
"password": "zabbix"
},
"id": 1,
"auth": null
}' http://172.25.70.4/zabbix/api_jsonrpc.php | python -m json.tool
jsonrpc
- API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;method
- 被调用的API方法名;params
- 将被传递给API方法的参数;id
- 请求的任意标识符;auth
-用户认证令牌; 因为我们还没有一个,它的设置null。
给脚本加上执行权限:
chmod +x zabbix-api
如果你正确提供了凭据,API返回的响应将包含用户身份验证令牌:
./zabbix-api
响应对象又包含以下属性:
jsonrpc
- JSON-RPC协议的版本;result
- 方法返回的数据;id
- 相应请求的标识符。
4.检索主机
我们现在有一个有效的用户身份验证令牌,可以用来访问Zabbix中的数据。
使用 host.get 方法检索所有已配置主机的ID,主机名和接口 :
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": "5d9c99c5f5def91aad3027d3ee231fe6"
}' http://172.25.70.4/zabbix/api_jsonrpc.php | python -m json.tool
注意:auth 属性现在设置为我们通过调用user.login方法获得的身份验证令牌。
响应对象将包含有关主机的请求的数据:
./zabbix-api
5.删除
关闭上一篇博文中的自动发泄和自动注册
object host.delete(array hosts) 该方法允许删除主机
参数
(array) 要删除的主机的ID.
返回值
(object) 返回值包含已删除主机ID的hostid属性.
删除server3:
vim zabbix-api
curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
"jsonrpc": "2.0",
"method": "host.delete",
"params": [
"10309" #上一步返回的被监控主机hostid号
],
"auth": "5d9c99c5f5def91aad3027d3ee231fe6",
"id": 2
}' http://172.25.70.4/zabbix/api_jsonrpc.php | python -m json.tool
响应:
刷新zabbix-web页面,查看server3已经被删除
6.创建
对象 host.create(对象/数组 hosts) 这个方法可以用来创建主机.
参数
(对象/数组) 要创建的主机.
另外,对于标准的主机属性,该方法接受下列参数
属性 类型 描述
groups
(必选) 对象/数组 添加主机的主机组. (主机组必须已定义groupid属性.)
interfaces
(必选) 对象/数组 为主机创建的接口.
templates 对象/数组 链接到主机的模板. (模板必须已定义过templateid属性.)
macros 对象/数组 为主机创建的用户宏.
inventory 对象 主机资产清单属性.
返回值
(对象) 返回包含已创建主机ID的属性hostid ,返回ID的顺序与传入主机的顺序一致
请求:
vim zabbix-api
curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "server3", #被监控的主机名
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "172.25.70.3", #被监控主机的ip
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "2" #建立的主机加入的群组id
}
],
"templates": [
{
"templateid": "10001" #建立的主机使用的模版id
}
]
},
"id":2,
"auth": "5d9c99c5f5def91aad3027d3ee231fe6"
}' http://172.25.70.4/zabbix/api_jsonrpc.php | python -m json.tool
响应:
== 刷新zabbix-web页面,查看server3已经添加==
如何获知groupid和templateid的值呢?我们可以在zabbix的web界面中打开某个群组和模版,即可在地址栏中得到