原文地址http://paperplane.ruhoh.com/zabbix/zabbix-api%E7%AE%80%E4%BB%8B%E5%8F%8A%E4%BD%BF%E7%94%A8/

如转载请注明以上出处。

API简介

Zabbix API开始扮演着越来越重要的角色,尤其是在集成第三方软件和自动化日常任务时。很难想象管理数千台服务器而没有自动化是多么的困难。Zabbix API为批量操作、第三方软件集成以及其他作用提供可编程接口。

Zabbix API是在1.8版本中开始引进并且已经被广泛应用。所有的Zabbix移动客户端都是基于API,甚至原生的WEB前端部分也是建立在它之上。Zabbix API 中间件使得架构更加模块化也避免直接对数据库进行操作。它允许你通过JSON RPC协议来创建、更新和获取Zabbix对象并且做任何你喜欢的操作【当然前提是你拥有认证账户】。

Zabbix API提供两项主要功能:

  • 远程管理Zabbix配置

  • 远程检索配置和历史数据

使用JSON

API 采用JSON-RPC实现。这意味着调用任何函数,都需要发送POST请求,输入输出数据都是以JSON格式。大致工作流如下:

可以采用脚本或者任何"手动"支持JSON RPC的工具来使用API。而首先需要了解的就是如何验证和如何使用验证ID来获取想要的信息。后面的演示会以Python脚本和基于Curl的例子来呈现API的基本使用。

基本请求格式

Zabbix API 简化的JSON请求如下:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "method.name",
  4. "params": {
  5. "param_1_name": "param_1_value",
  6. "param_2_name": "param_2_value"
  7. },
  8. "id": 1,
  9. "auth": "159121b60d19a9b4b55d49e30cf12b81",
  10. }

下面一行一行来看:

  • "jsonrpc": "2.0"-这是标准的JSON RPC参数以标示协议版本。所有的请求都会保持不变。

  • "method": "method.name"-这个参数定义了真实执行的操作。例如:host.create、item.update等等

  • "params"-这里通过传递JSON对象来作为特定方法的参数。如果你希望创建监控项,"name"和"key_"参数是需要的,每个方法需要的参数在Zabbix API文档中都有描述。

  • "id": 1-这个字段用于绑定JSON请求和响应。响应会跟请求有相同的"id"。在一次性发送多个请求时很有用,这些也不需要唯一或者连续

  • "auth": "159121b60d19a9b4b55d49e30cf12b81"-这是一个认证令牌【authentication token】用以鉴别用户、访问API。这也是使用API进行相关操作的前提-获取认证ID。


API 使用

  • 环境准备

Zabbix API是基于JSON-RPC 2.0规格,具体实现可以选择任何你喜欢的编程语言或者手动方式。这里我们采用的Python和基于Curl的方式来做示例。Python 2.7版本已经支持JSON,所以不再需要其他模块组件。当然可以采用Perl、Ruby、PHP之类的语言,使用前先确保相应JSON模块的安装。

  • 身份验证

任何Zabbix API客户端在真正工作之前都需要验证它自身。在这里是采用User.login方法。这个方法接受一个用户名和密码作为参数并返回验证ID,一个安全哈希串用于持续的API调用(在使用User.logout之前该验证ID均有效)。具体Python代码auth.py如下:

  1. #!/usr/bin/env python2.7
  2. #coding=utf-8
  3.  
  4. import json
  5. import urllib2
  6.  
  7. # based url and required header
  8. url = "http://monitor.example.com/api_jsonrpc.php"
  9. header = {"Content-Type": "application/json"}
  10.  
  11. # auth user and password
  12. data = json.dumps(
  13. {
  14. "jsonrpc": "2.0",
  15. "method": "user.login",
  16. "params": {
  17. "user": "Admin",
  18. "password": "zabbix"
  19. },
  20. "id": 0
  21. })
  22.  
  23. # create request object
  24. request = urllib2.Request(url,data)
  25. for key in header:
  26. request.add_header(key,header[key])
  27.  
  28. # auth and get authid
  29. try:
  30. result = urllib2.urlopen(request)
  31. except URLError as e:
  32. print "Auth Failed, Please Check Your Name And Password:",e.code
  33. else:
  34. response = json.loads(result.read())
  35. result.close()
  36. print "Auth Successful. The Auth ID Is:",response['result']

这里需要确保URL中的用户名和密码匹配。下面是运行结果:

picture1

可以看到,auth.py成功连接并认证。现在有了验证ID,它能够在新的API调用中被重用。

下面再来看基于CURL的方式来进行验证是如何实现的:

  1. curl -i -X POST -H 'Content-Type:application/json' -d'{"jsonrpc": "2.0","method":"user.authenticate","params":{"user":"Admin","password":"zabbix"},"auth": null,"id":0}' http://monitor.example.com/api_jsonrpc.php

picture2

  • 一般操作

这里举例说明如何获取监控主机列表【host list】。这段脚本需要采用auth.py中获取的验证ID并执行host.get方法来获取主机列表。来看具体代码get_host.py:

  1. #!/usr/bin/env python2.7
  2. #coding=utf-8
  3.  
  4. import json
  5. import urllib2
  6.  
  7. # based url and required header
  8. url = "http://monitor.example.com/api_jsonrpc.php"
  9. header = {"Content-Type": "application/json"}
  10.  
  11. # request json
  12. data = json.dumps(
  13. {
  14. "jsonrpc":"2.0",
  15. "method":"host.get",
  16. "params":{
  17. "output":["hostid","name"],
  18. "filter":{"host":""}
  19. },
  20. "auth":"2ee379e516f386ca4c24da7fd9fd5bb4", # the auth id is what auth script returns, remeber it is string
  21. "id":1,
  22. })
  23.  
  24. # create request object
  25. request = urllib2.Request(url,data)
  26. for key in header:
  27. request.add_header(key,header[key])
  28.  
  29. # get host list
  30. try:
  31. result = urllib2.urlopen(request)
  32. except URLError as e:
  33. if hasattr(e, 'reason'):
  34. print 'We failed to reach a server.'
  35. print 'Reason: ', e.reason
  36. elif hasattr(e, 'code'):
  37. print 'The server could not fulfill the request.'
  38. print 'Error code: ', e.code
  39. else:
  40. response = json.loads(result.read())
  41. result.close()
  42.  
  43. print "Number Of Hosts: ", len(response['result'])
  44.  
  45. for host in response['result']:
  46. print "Host ID:",host['hostid'],"Host Name:",host['name']

部分结果列表:

picture3

对比基于CURL的访问方式: curl -i -X POST -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0","method":"host.get","params":{"output":["hostid","name"],"filter":{"host":""}},"auth":"ecc543db662930c122b5fbedee60cc63","id":1}'http://monitor.example.com/api_jsonrpc.php

picture4

结果太多,未予显示。比较来看,采用脚本可以有更多的灵活性,而基于CURL的方式,对结果的处理不是很方便。原理则都是相通的。

除了这些获取信息以外,采用API调用同样可以进行创建操作,更新操作和删除操作等等。这也很容易让我们联想起数据库操作,当然比较这些采用API调用获取结果的方式,也不能忘掉这种最直接而危险的方式。在开始讨论中已经提到,Zabbix现在自带的前端实现部分是采用数据库操作,部分是基于API调用。在API还不是很成熟的现在,具体采用哪种方式,需要根据业务需求再来确定。

  • 数据流程

下面的流程图代表了Zabbix API 工作的典型工作流。验证(方法user.login)是获取验证ID的强制步骤。这个ID又允许我们调用API提供的任何权限允许的方法来进行操作。在之前的例子中没有提到user.logout方法,这也是一次验证ID能够重复使用的原因所在。使用user.logout方法后将会使验证ID失效,后面的操作将不能再使用此ID。

picture5


参考链接