文章目录

  • API简介
  • API定义
  • zabbix中的API
  • zabbix中API的作用
  • Zabbix API的应用
  • API常用接口
  • 查看zabbix系统监控的API接口以及API脚本方式获取身份令牌
  • 检索主机(通过名称获取数据)
  • 删除监控中的主机
  • 创建监控主机
  • 模板号(templateid)和组号(groupid)的获取方法
  • 模板号
  • 组号



curl命令详解:参考



zabbix官网API文档

https://www.zabbix.com/documentation/4.0/zh/manual/api/reference/host/create


https://www.zabbix.com/documentation/4.0/zh/manual/api/reference/host/object

API简介

API定义
  • API(Application Programming Interface),应用程序编程接口,是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部的工作机制的细节。
  • 简单来说,API就是对外的接口,利用API可以直接到达软件硬件内部来进行操作
zabbix中的API
  • Zabbix API开始扮演着越来越重要的角色,尤其是在集成第三方软件和自动化日常任务时。很难想象管理数千台服务器而没有自动化是多么的困难。Zabbix API为批量操作、第三方软件集成以及其他作用提供可编程接口。
  • Zabbix API是在1.8版本中开始引进并且已经被广泛应用。所有的Zabbix移动客户端都是基于API,甚至原生的WEB前端部分也是建立在它之上。Zabbix API 中间件使得架构更加模块化也避免直接对数据库进行操作。它允许你通过JSON RPC协议来创建、更新和获取Zabbix对象并且做任何你喜欢的操作【当然前提是你拥有认证账户】。
zabbix中API的作用
  • zabbix拥有完善的API,基于JSON RPC提供资产,主机,主机组,监控项,告警等方面的接口。在做运维自动化时,需要用API功能对zabbix二次开发。
  • Zabbix API为批量操作,第三方软件集成以及其他作用提供可编程接口。
  • Zabbix API提供两项主要功能:
    远程管理Zabbix配置
    远程检索配置和历史数据
  • API的工作流程如下:
    API采用JSON-RPC实现这意味着调用任何函数,都需要向POST请求,输入输出数据都是以JSON格式
    转备JSON对象,它描述了你想要做什么,比如创建主机
    获取JSON格式响应

Zabbix API的应用

API常用接口
user.login,用户登录
host.get(create|delete|update),主机操作
hostgroup.get(create|delete|update),主机组操作
item.get(create|delete|update),监控项目操作
history.get,历史数据查询
event.get,事件查询
trigger.get,触发器查询
查看zabbix系统监控的API接口以及API脚本方式获取身份令牌
[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`参数可以支持其他动词。  启用curl命令模拟json格式的post请求。
{
    "jsonrpc": "2.0",    #标准的JSON RPC参数以标示协议版本
    "method": "user.login",    #获取接口方法名
    "params": {
        "user": "Admin",
        "password": "zabbix"    #zabbix系统监控的用户名和密码
    },
    "id": 1,
    "auth": null    #用户的身份令牌,因为还没有获取所以为null。
}' http://172.25.24.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 
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "edbf01f09d5ec3bebc1a0dbf1dbcc60b"    #获取的身份令牌
}

zabbix api 获取 cpu zabbix的api_bc

检索主机(通过名称获取数据)

zabbix api 获取 cpu zabbix的api_API_02

  • 利用刚才获取的身份令牌,访问zabbix中的数据,下面实现host.get方法检索所有已配置主机的ID,主机名及其接口。
[root@server1 ~]# vim zabbix-api 
[root@server1 ~]# cat zabbix-api 
curl -s -XPOST -H 'Content-Type:application/json-rpc' -d '
{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
	"filter":{
		"host":[
			"Zabbix server",
			"server2",
			"server3"
		]
	}
    },
    "id": 1,
    "auth": "edbf01f09d5ec3bebc1a0dbf1dbcc60b"     #利用刚才获取的身份令牌
}' http://172.25.24.1/zabbix/api_jsonrpc.php | python -m json.tool

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

执行结果(图截的不全):

zabbix api 获取 cpu zabbix的api_bc_03

zabbix api 获取 cpu zabbix的api_json_04


zabbix api 获取 cpu zabbix的api_json_05

删除监控中的主机

zabbix api 获取 cpu zabbix的api_zabbix api 获取 cpu_06

  • server2此时的状态。
[root@server1 ~]# vim zabbix-api 
[root@server1 ~]# cat zabbix-api 
curl -s -XPOST -H 'Content-Type:application/json-rpc' -d '
{
    "jsonrpc": "2.0",
    "method": "host.delete",
    "params": [
		"10264"     #要删除主机的hostid
	],
    "id": 1,
    "auth": "edbf01f09d5ec3bebc1a0dbf1dbcc60b"
}' http://172.25.24.1/zabbix/api_jsonrpc.php | python -m json.tool

响应:
[root@server1 ~]# ./zabbix-api 
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10264"
        ]
    }
}
  • 在web界面查看server2已经被删除。
创建监控主机

zabbix api 获取 cpu zabbix的api_json_07

  • 创建一个具有IP接口的“Linux Server”主机,将其添加到主机组中,链接一个模板并且把MAC地址设置到主机资产清单里
  • 请求:
[root@server1 ~]# vim zabbix-api 
[root@server1 ~]# cat zabbix-api 
curl -s -XPOST -H 'Content-Type:application/json-rpc' -d '{
    "jsonrpc": "2.0",
    "method": "host.create",
    "params" : {
        "host": "server2",
        "interfaces": [
            {
                "type": 1,
                "main": 1,
                "useip": 1,
                "ip": "172.25.24.2",
                "dns": "",
                "port": "10050"
            }
        ],
        "groups": [
            {
                "groupid": "2"    #主机组id
            }
        ],
        "templates": [
            {
                "templateid": "10001"     #模版号
            }
        ]
    },
    "id": 1,
    "auth":"edbf01f09d5ec3bebc1a0dbf1dbcc60b"
}' http://172.25.24.1/zabbix/api_jsonrpc.php | python -m json.tool

响应:
[root@server1 ~]# ./zabbix-api 
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10267"
        ]
    }
}

执行结果:

zabbix api 获取 cpu zabbix的api_zabbix api 获取 cpu_08

模板号(templateid)和组号(groupid)的获取方法

模板号

zabbix api 获取 cpu zabbix的api_json_09


zabbix api 获取 cpu zabbix的api_json_10


zabbix api 获取 cpu zabbix的api_zabbix api 获取 cpu_11

组号

zabbix api 获取 cpu zabbix的api_bc_12

zabbix api 获取 cpu zabbix的api_json_13