Zabbix API

此篇博客内容承接上篇zabbix监控——创建监控主机，自动发现，自动注册

概览

Zabbix API允许你以编程方式检索和修改Zabbix的配置，并提供对历史数据的访问。它广泛用于：

创建新的应用程序以使用Zabbix；
将Zabbix与第三方软件集成；
自动执行常规任务。

Zabbix API是基于Web的API，作为Web前端的一部分提供。它使用JSON-RPC 2.0协议，这意味着两件事：

该API包含一组独立的方法；
客户端和API之间的请求和响应使用JSON格式进行编

Zabbix API由许多名义上分组的独立API方法组成。每个方法执行一个特定任务。例如，方法 host.create 隶属于 host 这个API分组 ，用于创建新主机。历史上，API分组有时被称为“类”。
大多数API至少包含四种方法： get， create， update 和 delete ，分别是检索，创建，更新和删除数据，但是某些API提供一套完全不同的一组方法。

详见官网Zabbix Documentation 4.0

API的验证

[root@server4 ~]# vim zabbix-api

curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "user": "Admin",
        "password": "zabbix"
    },  
    "id": 1,
    "auth": null
}' http://172.25.62.4/zabbix/api_jsonrpc.php | python -m json.tool

在访问Zabbix中的任何数据之前，你需要登录并获取身份验证令牌。
让我们仔细看看示例请求对象。它具有以下属性：

jsonrpc - API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;
method - 被调用的API方法名;
params - 将被传递给API方法的参数;
id - 请求的任意标识符;
auth -用户认证令牌; 因为我们还没有一个，它的设置null。

[root@server4 ~]# chmod 755 zabbix-api 

之后给这个脚本执行权限再执行。

[root@server4 ~]# ./zabbix-api 

API返回的响应将包含用户身份验证令牌。
响应对象又包含以下属性：

jsonrpc - JSON-RPC协议的版本;
result - 方法返回的数据;
id - 相应请求的标识符

检索主机

我们现在有一个有效的用户身份验证令牌，可以用来访问Zabbix中的数据。 例如，让我们使用 host.get 方法检索所有已配置主机的ID，主机名和接口 ：

[root@server4 ~]# ./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": "ccae96ce70fe98398da7bf06f5222635"
}' http://172.25.62.4/zabbix/api_jsonrpc.php | python -m json.tool

请注意， auth 属性现在设置为我们通过调用user.login方法获得的身份验证令牌。

发现了监控的3台主机。

删除主机

为了看到删除的效果，需要再web端禁用自动发现和自动注册的规则。

接下来编写api文件，通过识别hostid进行删除。

curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
    "jsonrpc": "2.0",
    "method": "host.delete",
    "params": [
                "10267"
        ],
    "id": 2,
    "auth": "ccae96ce70fe98398da7bf06f5222635"
}' http://172.25.62.4/zabbix/api_jsonrpc.php | python -m json.tool

使用server3的hostid“10267“在监控列表中删除server3.

创建主机

创建
描述

对象 host.create(对象/数组 hosts)

这个方法可以用来创建主机.
参数

(对象/数组) 要创建的主机.

另外，对于标准的主机属性，该方法接受下列参数

属性	类型	描述
groups(必选)	对象/数组	添加主机的主机组，主机组必须已定义groupid属性.
interfaces(必选)	对象/数组	为主机创建的接口.
templates	对象/数组	链接到主机的模板，模板必须已定义过templateid属性.
macros	对象/数组	为主机创建的用户宏.
inventory	对象	主机资产清单属性.

返回值
(对象) 返回包含已创建主机ID的属性hostid ,返回ID的顺序与传入主机的顺序一致。

[root@server4 ~]# 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.62.3",		##添加主机的ip
                "dns": "", 
                "port": "10050"
            }
        ],
        "groups": [
            {
                "groupid": "2" 
            }
        ],
        "templates": [
            {
                "templateid": "10001"
            }
        ]
    
    },  
    "id": 2,
    "auth": "ccae96ce70fe98398da7bf06f5222635"
}' http://172.25.62.4/zabbix/api_jsonrpc.php | python -m json.tool

[root@server4 ~]# ./zabbix-api 

添加成功。