概览
Zabbix API允许你以编程方式检索和修改Zabbix的配置,并提供对历史数据的访问。它广泛用于:
- 创建新的应用程序以使用Zabbix;
- 将Zabbix与第三方软件集成;
- 自动执行常规任务。
Zabbix API是基于Web的API,作为Web前端的一部分提供。它使用JSON-RPC 2.0协议,这意味着两件事:
- 该API包含一组独立的方法;
- 客户端和API之间的请求和响应使用JSON格式进行编码。
有关协议和JSON的更多信息可以在 JSON-RPC 2.0 规范 和 JSON 格式主页中找到。
结构
Zabbix API由许多名义上分组的独立API方法组成。每个方法执行一个特定任务。例如,方法 host.create
隶属于 host 这个API分组 ,用于创建新主机。历史上,API分组有时被称为“类”。
注意:大多数API至少包含四种方法: get
, create
, update
和 delete
,分别是检索,创建,更新和删除数据,但是某些API提供一套完全不同的一组方法。
执行请求
当完成了前端的安装配置后,你就可以使用远程HTTP请求来调用API。为此,需要向 api_jsonrpc.php
位于前端目录中的文件发送HTTP POST请求。例如,如果你的Zabbix前端安装在 http://10.0.0.71/zabbix, 那么用HTTP请求来调用 apiinfo.version
方法就如下面这样:
POST http://company.com/zabbix/api_jsonrpc.php HTTP/1.1
Content-Type: application/json-rpc
{"jsonrpc":"2.0","method":"apiinfo.version","id":1,"auth":null,"params":{}}
请求的 Content-Type
头部必须设置为以下值之一: application/json-rpc
, application/json
或 application/jsonrequest
。
注意:你可以使用任何HTTP客户端或JSON-RPC测试工具手动执行API请求,但对于开发应用程序,建议使用 社区维护的程序库。
示例
以下部分将详细介绍一些使用示例。
1.验证
在访问Zabbix中的任何数据之前,你需要登录并获取身份==验证令牌==。这可以使用该 user.login
方法完成。
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"user": "Admin",
"password": "zabbix"
},
"id": 1,
"auth": null
}
请求对象的属性:
jsonrpc
- API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;method
- 被调用的API方法名;params
- 将被传递给API方法的参数;id
- 请求的任意标识符;auth
-用户认证令牌; 因为我们还没有一个,它的设置null。
使用curl命令测试获取==验证令牌==
[root@web03 ~]# curl -s -X POST -H 'Content-Type: application/json' http://10.0.0.71/zabbix/api_jsonrpc.php -d '
> {
> "jsonrpc": "2.0",
> "method": "user.login",
> "params": {
> "user": "Admin",
> "password": "zabbix"
> },
> "id": 1,
> "auth": null
> }'
API返回的响应将包含用户身份验证令牌:
{
"jsonrpc":"2.0",
"result":"41b658b49d8799dac721555f1d53b93f",
"id":1
}
响应对象又包含以下属性:
jsonrpc
- JSON-RPC协议的版本;result
- 方法返回的数据;id
- 相应请求的标识符。
2.检索主机
我们现在有一个有效的用户身份验证令牌,可以用来访问Zabbix中的数据。 例如,让我们使用 host.get
方法检索所有已配置主机的ID,主机名和接口 :
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"hostid",
"host"
],
"selectInterfaces": [
"interfaceid",
"ip"
]
},
"id": 2,
"auth": "41b658b49d8799dac721555f1d53b93f"
}
注意:auth
属性现在设置为我们通过调用user.login
方法获得的身份验证令牌。
使用curl命令测试API
[root@web03 ~]# curl -s -X POST -H 'Content-Type: application/json' http://10.0.0.71/zabbix/api_jsonrpc.php -d '
> {
> "jsonrpc": "2.0",
> "method": "host.get",
> "params": {
> "output": [
> "hostid",
> "host"
> ],
> "selectInterfaces": [
> "interfaceid",
> "ip"
> ]
> },
> "id": 2,
> "auth": "41b658b49d8799dac721555f1d53b93f"
> }'
响应对象将包含有关主机的请求的数据:
{
"jsonrpc":"2.0",
"result":[
{
"hostid":"10084",
"host":"Zabbix server",
"interfaces":[
{
"interfaceid":"1",
"ip":"127.0.0.1"
}
]
}
],
"id":2
}
3.创建监控项
使用从上一个请求host.get
中获得的数据,在主机 “Zabbix server” 上创建一个新 监控项 。这个可以通过使用方法 item.create
:
{
"jsonrpc": "2.0",
"method": "item.create",
"params": {
"name": "Free disk space on $1",
"key_": "vfs.fs.size[/home/joe/,free]",
"hostid": "10084",
"type": 0,
"value_type": 3,
"interfaceid": "1",
"delay": 30
},
"auth": "41b658b49d8799dac721555f1d53b93f",
"id": 3
}
curl命令测试
[root@web03 ~]# curl -s -X POST -H 'Content-Type: application/json' http://10.0.0.71/zabbix/api_jsonrpc.php -d '
> {
> "jsonrpc": "2.0",
> "method": "item.create",
> "params": {
> "name": "Free disk space on $1",
> "key_": "vfs.fs.size[/home/whb/,free]",
> "hostid": "10084",
> "type": 0,
> "value_type": 3,
> "interfaceid": "1",
> "delay": 30
> },
> "auth": "41b658b49d8799dac721555f1d53b93f",
> "id": 3
> }'
成功的响应将包含新创建监控项的ID,可用于在以后请求中引用监控项:
{
"jsonrpc":"2.0",
"result":{
"itemids":["33777"]
},
"id":3
}
注意:item.create
方法和其他的创建(create)方法,也可以接受对象数组,并通过一次API调用中创建多个监控项
4.创建主机
创建一个具有IP接口的“web03”主机,将其添加到主机组中,链接一个模板并且把MAC地址设置到主机资产清单里 请求:
{
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "web03",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "172.16.1.9",
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "15"
}
],
"templates": [
{
"templateid": "10305"
}
],
"inventory_mode": 0,
"inventory": {
"macaddress_a": "01234",
"macaddress_b": "56768"
}
},
"auth": "41b658b49d8799dac721555f1d53b93f",
"id": 1
}
响应:
{
"jsonrpc":"2.0",
"result":{
"hostids":[
"10328"
]
},
"id":1
}