Zabbix——通过API接口管理Zabbix所监控主机

2024-02-16 22:34:58

一.什么是API

API（Application Programming Interface，应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

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提供一套完全不同的一组方法。

根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将 API 分为四种类型：

<span style="color:#000000"><code>远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。
标准查询语言（SQL）：是标准的访问数据的查询语言，通过通用数据库实现应用程序间的数据共享。
文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。
</code></span>

主机和主机组

<span style="color:#000000"><code>一般来讲，Zabbix主机是指你希望监控的那些设备，例如服务器、工作站、交换机等等。
创建主机是使用Zabbix过程中的一个首要任务。例如，如果你想在一台服务器“X”上监控一些参数，你必须首先创建一个主机称之为“服务器X”，然后就可以查看添加监控项到这台“服务器X”上。
主机组是由主机组成的。
</code></span>

二.关于API实验的具体实现

<1>查看zabbix监控系统的api接口：（验证）

在可以访问Zabbix内部的任何数据之前，需要登录并获得身份验证令牌。这可以使用user.login方法来完成。假想以标准ZabBix的Admin用户登录。那么JSON请求将是这样的：

<span style="color:#000000"><code>[root@server1 ~]# vim zabbix-api
[root@server1 ~]# cat zabbix-api
curl -s -XPOST -H 'Content-Type: application/json-rpc' -d '         #-s表示静默输出（即不需要的信息，不输出）
{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "user": "Admin",          #zabbix监控系统的用户名和密码
        "password": "zabbix"
    },
    "id": 1,
    "auth": null
}' http://172.25.27.1/zabbix/api_jsonrpc.php | python -m json.tool
[root@server1 ~]# chmod +x zabbix-api 
[root@server1 ~]# ./zabbix-api        
{
"id": 1,
"jsonrpc": "2.0",
"result": "8fc9eed51b36851050f6d7325aa2732b"
}
</code></span>

<2>查看主机信息：（检索主机）

<span style="color:#000000"><code>[root@server1 ~]# vim zabbix-api
[root@server1 ~]# cat zabbix-api
curl -s -X POST -H 'Content-Type:application/json' -d '
{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["host"]
    },
    "auth": "8fc9eed51b36851050f6d7325aa2732b",       #这一串数字是上个实验的result显示的数字
    "id": 1
}' http://172.25.27.1/zabbix/api_jsonrpc.php | python -m json.tool
</code></span>

<span style="color:#000000"><code>[root@server1 ~]# ./zabbix-api 
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
        {
            "host": "Zabbix server",
            "hostid": "10084"
        },
        {
            "host": "server2",
            "hostid": "10264"
        },
        {
            "host": "server3",
            "hostid": "10265"
        }
    ]
}
</code></span>

<3>删除zabbix监控中的主机：

通过host.delete方法,10264是server2的hostid

<span style="color:#000000"><code>[root@server1 ~]# cat zabbix-api
curl -s -X POST -H 'Content-Type:application/json' -d '
{
    "jsonrpc": "2.0",
    "method": "host.delete",
    "params": [
        "10264"
    ],
    "auth": "8fc9eed51b36851050f6d7325aa2732b",
    "id": 1
}' http://172.25.27.1/zabbix/api_jsonrpc.php | python -m json.tool
</code></span>

删除成功:

<span style="color:#000000"><code>[root@server1 ~]# ./zabbix-api 
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10264"
        ]
    }
}
</code></span>

去刷新，没有server2，我在做实验的时候把本机自己的也删除了，所以只剩下server3

<4>在zabbix监控中创建被监控主机：（创建主机）

<span style="color:#000000"><code>[root@server1 ~]# cat zabbix-api
curl -s -X POST -H 'Content-Type:application/json' -d '
{
    "jsonrpc": "2.0",
    "method": "host.create",
    "params": {
        "host": "server2",    #要创建的主机的名字
        "interfaces": [
            {
                "type": 1,
                "main": 1,
                "useip": 1,
                "ip": "172.25.27.2",           #要创建的主机对应的ip地址
                "dns": "",
                "port": "10050"     
            }
        ],
        "groups": [
            {
                "groupid": "2"        #要添加的组对应的组id(根据组而定)
            }
        ],
        "templates": [
            {
                "templateid": "10001"        #要添加的模板对应的模板的id号(根据模板而定)
            }
        ]
    },
    "auth": "8fc9eed51b36851050f6d7325aa2732b",
    "id": 1
}' http://172.25.27.1/zabbix/api_jsonrpc.php | python -m json.tool
</code></span>

添加的模板对应的模板的id号可以这样看：

<span style="color:#000000"><code>[root@server1 ~]# ./zabbix-api 
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10267"
        ]
    }
}
</code></span>