API

概述

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

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

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

  • API 由一组单独的方法组成；
  • 客户端和 API 之间的请求和响应使用 JSON 格式进行编码。

作为Web前端的一部分提供。它使用JSON-RPC 2.0协议，这意味着两件事： 1.该API包含一组独立的方法； 2.客户端和API之间的请求和响应使用JSON格式进行编码

结构

Zabbix API包含许多方法，这些方法都名义上分组为单组的API。每个方法执行一个特定任务。例如，方法 host.create 隶属于 host 这个API ，用于创建新主机。历史上，API有时被称为“类”。

大多数API至少包含四种方法： get， create， update 和 delete ，分别是检索，创建，更新和删除数据，但是某些API提供一套完全不同的一组方法。

执行请求

当完成了前端的安装配置后，你就可以使用远程HTTP请求来调用API。为此，需要向位于前端目录中的
api_jsonrpc.php 文件发送HTTP POST请求。例如，如果你的Zabbix前端安装在
http://company.com/， 那么用HTTP请求来调用 apiinfo.version 方法就如下面这样

POST http://company.com/api_jsonrpc.php HTTP/1.1
Content-Type: application/json-rpc
{"jsonrpc":"2.0","method":"apiinfo.version","id":1,"auth":null,"params":{}}

调用API-验证令牌

在访问Zabbix中的任何数据之前，你需要登录并获取身份验证令牌。这可以使用该 user.login 方法完成。让我们假设你想要以标准Zabbix Admin用户身份登录。然后，你的JSON请求将如下所示：

#可以使用jq工具把返回结果解析为json格式  //如果没有此工具，yum安装即可
[root@zabbix ~]# curl -s -X POST -H 'Content-Type:application/json' -d ' 
{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "user": "Admin",
        "password": "zabbix"
    },
    "id": 1,
    "auth": null
}' http://10.0.0.71/api_jsonrpc.php
{"jsonrpc":"2.0","result":"a6ef611409b990c6d2f3b71845dfce17","id":1}[root@zabbix ~]#

使用postman工具：

image-20230821161452140

获取主机组ID

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

[root@zabbix ~]# curl -XPOST -H 'Content-Type: application/json-rpc' -d '{
  "jsonrpc": "2.0",
  "method": "hostgroup.get",
  "params": {
    "output": "extend",
    "filter": {
      "name": [
        "自定义监控项组"
      ]
    }
  },
  "auth": "844591b9872ce4f34d61b4e596df4ba5",
  "id": 1
}' http://10.0.0.71/api_jsonrpc.php | jq

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   317    0   131  100   186   1104   1568 --:--:-- --:--:-- --:--:--  1576
{
  "jsonrpc": "2.0",
  "result": [
    {
      "groupid": "18",      #//主机组ID
      "name": "自定义监控项组",
      "internal": "0",
      "flags": "0"
    }
  ],
  "id": 1
}

image-20230821163249771

获取模板ID

[root@zabbix ~]# curl -XPOST -H 'Content-Type: application/json-rpc' -d '
{
  "jsonrpc": "2.0",
  "method": "template.get",
    "params": {
    "output": "extend",
      "filter": {
      "host": [
        //模板名称
        "dir_item"
        ]
      }
    },
  "auth": "844591b9872ce4f34d61b4e596df4ba5",
  "id": 1
}' http://10.0.0.71/api_jsonrpc.php | jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  1007    0   835  100   172   7278   1499 --:--:-- --:--:-- --:--:--  7324
{
  "jsonrpc": "2.0",
  "result": [
    {
      "proxy_hostid": "0",
      "host": "dir_item",
      "status": "3",
      "disable_until": "0",
      "error": "",
      "available": "0",
      "errors_from": "0",
      "lastaccess": "0",
      "ipmi_authtype": "-1",
      "ipmi_privilege": "2",
      "ipmi_username": "",
      "ipmi_password": "",
      "ipmi_disable_until": "0",
      "ipmi_available": "0",
      "snmp_disable_until": "0",
      "snmp_available": "0",
      "maintenanceid": "0",
      "maintenance_status": "0",
      "maintenance_type": "0",
      "maintenance_from": "0",
      "ipmi_errors_from": "0",
      "snmp_errors_from": "0",
      "ipmi_error": "",
      "snmp_error": "",
      "jmx_disable_until": "0",
      "jmx_available": "0",
      "jmx_errors_from": "0",
      "jmx_error": "",
      "name": "自定义监控模板",
      "flags": "0",
      "templateid": "10438",             #//模板ID
      "description": "",
      "tls_connect": "1",
      "tls_accept": "1",
      "tls_issuer": "",
      "tls_subject": "",
      "tls_psk_identity": "",
      "tls_psk": "",
      "proxy_address": "",
      "auto_compress": "1"
    }
  ],
  "id": 1
}

image-20230821164153962

使用zabbix API创建主机

[root@zabbix ~]# curl -XPOST -H 'Content-Type: application/json-rpc' -d '
curl -XPOST -H 'Content-Type: application/json-rpc' -d '{
    "jsonrpc": "2.0",
    "method": "host.create",
    "params": {
        "host": "web03",
        "interfaces": [
            {
                "type": 1,
                "main": 1,
                "useip": 1,
                "ip": "10.0.0.9",
                "dns": "",
                "port": "10050"
            }
        ],
        "groups": [
            {
                "groupid": "18"
            }
        ],
        "tags": [
            {
                "tag": "IP",
                "value": "172.16.1.9",
            }
        ],
        "templates": [
            {
                "templateid": "10438"
            }
        ],
        "macros": [
            {
                "macro": "{$USER_ID}",
                "value": "123321"
            },
            {
                "macro": "{$USER_LOCATION}",
                "value": "0:0:0",
                "description": "latitude, longitude and altitude coordinates"
            }
        ],
        "inventory_mode": 0,
        "inventory": {
            "macaddress_a": "01234",
            "macaddress_b": "56768"
        }
    },
    "auth": "844591b9872ce4f34d61b4e596df4ba5",
    "id": 1
}' http://10.0.0.71/api_jsonrpc.php

image-20230821165842405

image-20230821165858423

zabbix性能调优

1) Zabbix属于写多读少的业务, 所以需要针对zabbix的MySQL进行拆分。MySQL一定要使用SSD固态
2) 将Zabbix-Agent被动监控模式, 调整为主动监控模式。
3) 使用zabbix-proxy分布式监控, 在大规模监控时用于缓解Zabbix-Server压力
4) 去掉无用监控项, 增加监控项的取值间隔, 减少历史数据保存周期(由housekeeper进程定时清理)
5)针对于Zabbix-server进程调优, 谁忙就加大谁的进程数量, 具体取决实际情况, 不是越大越好

[root@zabbix ~]# vim /etc/zabbix/zabbix_server.conf
StartPollers=20
StartPollersUnreachable=2

6)针对于Zabbix-server缓存调优, 谁的剩余内存少, 就加大它的缓存值(zabbix cache usage图表)6)针对于
Zabbix-server缓存调优, 谁的剩余内存少, 就加大它的缓存值(zabbix cache usage图表)

[root@zabbix ~]# vim /etc/zabbix/zabbix_server.conf
CacheSize=8M
HistoryCacheSize=16M
HistoryIndexCacheSize=4M

7)关注管理->队列, 是否有被延迟执行的监控项

image-20230821171245396

0