基本认知:
Zabbix API允许你以编程方式检索和修改Zabbix的配置,并提供对历史数据的访问。它广泛用于:
创建新的应用程序以使用Zabbix;
将Zabbix与第三方软件集成;
自动执行常规任务。
Zabbix API是基于Web的API,作为Web前端的一部分提供。它使用JSON-RPC 2.0协议,这意味着两件事:
该API包含一组独立的方法;
客户端和API之间的请求和响应使用JSON格式进行编码。
大多数API至少包含四种方法: get, create, update 和 delete ,分别是检索,创建,更新和删除数据,但是某些API提供一套完全不同的一组方法。
当完成了前端的安装配置后,你就可以使用远程HTTP请求来调用API。为此,需要向 api_jsonrpc.php 位于前端目录中的文件发送HTTP POST请求。例如,如果你的Zabbix前端安装在 http://company.com/zabbix, 那么用HTTP请求来调用 apiinfo.version 方法。例如:
vim zabbix.api
curl -s -XPOST -H 'Content-Type: application/json-rpc' -d '
{
"jsonrpc":"2.0", ##API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;
"method":"user.login", ##被调用的API方法名;
"params":{ ##被传递给API方法的参数
"user": "Admin",
"password": "zabbix"
},
"id":1, ##请求的任意标识符
"auth":null ##用户认证令牌; 因为我们还没有一个,它的设置null
}' http://172.25.30.1/zabbix/api_jsonrpc.php | python -m json.tool
chmod +x zabbix.api ##给脚本运行权限
./zabbix.api
{
"id": 1, ##相应请求的标识符
"jsonrpc": "2.0", ##JSON-RPC协议的版本
"result": "029b40e9ff5bf325bd7c332fc2e5c51e" ##方法返回的数据;
}
注:请求的 Content-Type 头部必须设置为以下值之一: application/json-rpc, application/json 或 application/jsonrequest。
2. 检索主机
在上一个脚本中可以获得一个用户认证令牌,那就可以使用该用户访问Zabbix中的数据。可以使用 host.get 方法检索所有已配置主机ID,主机名和接口 。
vim zabbix.api
curl -s -XPOST -H 'Content-Type: application/json-rpc' -d '
{
"jsonrpc": "2.0",
"method": "host.get", ##通过host.get方法
"params": {
"output": [
"hostid", ##获得主机号
"host" ##获得主机名
],
"selectInterfaces": [
"interfaceid", ##接口
"ip" ##ip号
]
},
"id": 2,
"auth": "029b40e9ff5bf325bd7c332fc2e5c51e" ##用户认证码
}' http://172.25.30.1/zabbix/api_jsonrpc.php | python -m json.tool
./zabbix.api ##运行zabbix.api
{
"id": 2, ##请求标示符
"jsonrpc": "2.0", ##版本号
"result": [
{
"host": "Zabbix server", ##主机号
"hostid": "10084",
"interfaces": [
{
"interfaceid": "1", ##api接口号
"ip": "127.0.0.1" ##ip
}
]
},
{
"host": "server2", ##主机名
"hostid": "10265",
"interfaces": [
{
"interfaceid": "4", ##api接口号
"ip": "172.25.30.2" ##ip
}
]
}
]
}
vim zabbix.api
curl -s -XPOST -H 'Content-Type: application/json-rpc' -d '
{
"jsonrpc": "2.0",
"method": "host.delete", ##API接口方法
"params": [
"10265" ##这个参数为hostid,可以通过访问删除主机页面获得
],
"auth": "029b40e9ff5bf325bd7c332fc2e5c51e", ##用户认证
"id": 1
}' http://172.25.30.1/zabbix/api_jsonrpc.php | python -m json.tool
./zabbix.api
{
"id": 1,
"jsonrpc": "2.0",
"result": {
"hostids": [
"10265" ##删除成功
]
}
}
vim zabbix.api
curl -s -XPOST -H 'Content-Type: application/json-rpc' -d '
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "server2", ##主机名
"interfaces": [ ##为主机创建的接口.
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "172.25.30.2",
"dns": "",
"port": "10050"
}
],
"groups": [ ##添加主机的主机组,主机组必须已定义groupid属性,可以从在主机群组中url找到
{
"groupid": "2"
}
],
"templates": [ ##链接到主机的模板.模板必须已定义过templateid属性.可以从模版中url找到
{
"templateid": "10001"
}
]
},
"id": 2,
"auth": "029b40e9ff5bf325bd7c332fc2e5c51e"
}' http://172.25.30.1/zabbix/api_jsonrpc.php | python -m json.tool
./zabbix.api
{
"id": 2,
"jsonrpc": "2.0",
"result": {
"hostids": [
"10267" ##新加主机的hostid
]
}
}