结合API进行检索、删除、创建主机
1、什么是API
-
API的概念
API(Application Programming Interface),应用程序编程接口,是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部的工作机制的细节。简单来说,API就是对外的接口,利用API可以直接到达软件硬件内部来进行操作。 -
zabbix中的API
-
Zabbix API开始扮演着越来越重要的角色,尤其是在集成第三方软件和自动化日常任务时。很难想象管理数千台服务器而没有自动化是多么的困难。Zabbix API为批量操作、第三方软件集成以及其他作用提供可编程接口。
-
Zabbix API是在1.8版本中开始引进并且已经被广泛应用。所有的Zabbix移动客户端都是基于API,甚至原生的WEB前端部分也是建立在它之上。Zabbix API 中间件使得架构更加模块化也避免直接对数据库进行操作。它允许你通过JSON RPC协议来创建、更新和获取Zabbix对象并且做任何你喜欢的操作【当然前提是你拥有认证账户】。
-
Zabbix API提供两项主要功能:
- 远程管理Zabbix配置;
- 远程检索配置和历史数据。
-
-
API的工作流程如下:
- API采用JSON-RPC实现这意味着调用任何函数,都需要向POST请求,输入输出数据都是以JSON格式;
- 转备JSON对象,它描述了你想要做什么,比如创建主机、获取JSON格式响应。
2、结构
- Zabbix API由许多名义上分组的独立API方法组成。每个方法执行一个特定任务。例如,方法 host.create 隶属于 host 这个API分组 ,用于创建新主机。历史上,API分组有时被称为“类”;
- 大多数API至少包含四种方法: get, create, update 和 delete ,分别是检索,创建,更新和删除数据,但是某些API提供一套完全不同的一组方法。
3、Zabbix API的应用
- API常用接口:
user.login,用户登录
host.get(create|delete|update),主机操作
hostgroup.get(create|delete|update),主机组操作
item.get(create|delete|update),监控项目操作
history.get,历史数据查询
event.get,事件查询
trigger.get,触发器查询
- 查看zabbix系统监控的API接口以及API脚本方式获取身份令牌(查看监控主机)
在访问Zabbix中的任何数据之前,你需要登录并获取身份验证令牌。这可以使用该user.login 方法完成。让我们假设你想要以标准Zabbix Admin用户身份登录
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://192.168.0.101/zabbix/api_jsonrpc.php | python -m json.tool
chmod +x zabbix-api
./zabbix-api
上述编辑的zabbix-api文件中相关参数的解释:
jsonrpc - API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;
method - 被调用的API方法名;
params - 将被传递给API方法的参数;
id - 请求的任意标识符;
auth -用户认证令牌; 因为我们还没有一个,它的设置null。
注意:我们在上述的结果中可以看到还有一些统计的信息,我们可以重新编辑一下zabbix-api文件,让这些统计信息不要显示
响应对象又包含以下属性:
jsonrpc - JSON-RPC协议的版本;
result - 方法返回的数据;
id - 相应请求的标识符。
- 检索监控中的主机
我们现在有一个有效的用户身份验证令牌,可以用来访问Zabbix中的数据。
- 删除监控中的主机
首先删除之前实验中开启的自动发现和自动注册
刷新zabbix-web页面,查看server3是否还存在
- 创建监控主机
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": "192.168.0.103",
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "2"
}
],
"templates": [
{
"templateid": "10001"
}
]
},
"id":2,
"auth": "14c48dd8a0fd730af9191a074995b3a3"
}' http://192.168.0.101/zabbix/api_jsonrpc.php | python -m json.tool
./zabbix-api
如何获知groupid和templateid的值呢?我们可以在zabbix的web界面中打开某个群组和模版,即可在地址栏中得到
刷新zabbix-web页面,查看server3是否已经添加