企业级监控系统zabbix---通过API接口远程管理Zabbix所监控主机

小灰灰 2023-07-18 06:20 76阅读 0赞

### 文章目录 ###

*  一、API
 *   *  1、什么是API
 *  二、API实验的具体实现
 *   *  2.1 查看zabbix监控系统的api接口
     *  2.2 检索主机（通过名称获取数据）
     *  2.3 删除监控中的主机
     *  2.4 创建监控主机

# 一、API #

## 1、什么是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 分为四种类型：**

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

# 二、API实验的具体实现 #

## 2.1 查看zabbix监控系统的api接口 ##

**在可以访问Zabbix内部的任何数据之前，需要登录并获得`身份验证令牌`。这可以使用`user.login`方法来完成。**

假想以标准ZabBix的Admin用户登录。那么JSON请求将是这样的：

[root@server1 ~]# vim zabbix-api
    [root@server1 ~]# cat zabbix-api 
    curl  -s -XPOST -H 'Content-Type: application/json-rpc' -d '     
      ##-s 静默模式，不输出任何东西；curl默认的HTTP动词是GET，使用`-X`参数可以支持其他动词
    { 
        "jsonrpc": "2.0",        ##标准的JSON RPC参数以标示协议版本,jsonrpc - API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;
        "method": "user.login",  ##获取接口方法名,被调用的API方法名;
        "params": {               ##params - 将被传递给API方法的参数;
            "user": "Admin",      
            "password": "zabbix"  ##zabbix系统监控的用户名和密码
        },
        "id": 1,                  ##id - 请求的任意标识符;
        "auth": null              ##用户的身份令牌，因为还没有获取所以为null。
    }' http://172.25.2.1/zabbix/api_jsonrpc.php | python -m json.tool
    	###python..将其标准化输出  
    	##使用post方法向该网址发送此json对象，api_jsonrpc.php是调用api的php脚本，可以安装可视化前端目录查看
    [root@server1 ~]# chmod +x zabbix-api     ##给脚本加上执行权限：
    [root@server1 ~]# ./zabbix-api     
    
    如果你正确提供了凭据，API返回的响应将包含用户身份验证令牌：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 1]  
响应对象又包含以下属性：  
`jsonrpc` \- JSON-RPC协议的版本;  
`result` \- 方法返回的数据;  
`id` \- 相应请求的标识符。

## 2.2 检索主机（通过名称获取数据） ##

我们现在有一个有效的用户身份验证令牌，可以用来访问Zabbix中的数据。  
使用`host.get`方法来获取主机检

利用刚才获取的身份令牌，访问zabbix中的数据，下面实现host.get方法检索所有已配置主机的ID，主机名及其接口。

vim 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": "0ffc65582da0f9d8793163cd22ff4c31"
    }' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool
    
    [root@server1 ~]# ./zabbix-api   ##响应对象将包含有关主机的请求的数据：

注意：auth 属性现在设置为我们通过调用user.login方法获得的身份验证令牌。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 2]

## 2.3 删除监控中的主机 ##

关闭上一篇博文中的自动发现和自动注册，如果没有做过可忽略  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 4]  
使用`host.delete`方法来删除主机。

**删除server3：**

vim zabbix-api
    
    curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
    { 
        "jsonrpc": "2.0",
        "method": "host.delete",
        "params": [
            "10308"	#上一步返回的被监控主机hostid号
        ],
        "auth": "0ffc65582da0f9d8793163cd22ff4c31",
        "id": 2
    }' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool

**响应：**

./zabbix-api

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 5]  
刷新zabbix-web页面，查看server3已经被删除  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 6]

## 2.4 创建监控主机 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 7]  
我们首先要获取，**模板号（templateid）和组号（groupid）**：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 8]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 9]  
**请求：**

创建一个具有IP接口的“Linux Server”主机，将其添加到主机组中，链接一个模板并且把MAC地址设置到主机资产清单里

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.254.3",	#被监控主机的ip
                    "dns": "",
                    "port": "10050"
                }
            ],
            "groups": [
                { 
                    "groupid": "2"	#建立的主机加入的群组id
                }
            ],
            "templates": [
                { 
                    "templateid": "10001"	#建立的主机使用的模版id
                }
            ]
        },
        "id":2,
        "auth": "0ffc65582da0f9d8793163cd22ff4c31"
    }' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool

**响应：**

./zabbix-api

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 10]  
刷新zabbix-web页面，查看server3已经添加  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 11]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70]: /images/20230528/562541bbaaa8401b86765cfecfd37ad9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 1]: /images/20230528/3a77a87d16a54b46809399d9ccbdef79.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 2]: /images/20230528/587c8401411345a3b2c74605ee9e19a9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 3]: /images/20230528/0c4a6261f94c4dc29e6ee5b5003b4c9e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 4]: /images/20230528/d8e85947bc704029b6822528da91232e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 5]: /images/20230528/d94c8e53916e4ef5b08fb4ac495f11c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 6]: /images/20230528/0ba814a94e274ba0a0300c6a051c4a13.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 7]: /images/20230528/14f5e463c0274085b06425ef77aa7aeb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 8]: /images/20230528/6a2350ee994e49a787d236f9d7a40479.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 9]: /images/20230528/0e14c0ad884248f5ae06bf8589db8b7b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 10]: /images/20230528/cee234b37ab6499e9f0c8f2c63b20e8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNjk2OQ_size_16_color_FFFFFF_t_70 11]: /images/20230528/35e00f4ebab14d96ab3b05f0921fbce2.png