遠程管理Zabbix配置。
遠程檢索配置和歷史數據。
Zabbix API?采用JSON-RPC實現，意味著調用任何函數，都需要發送POST請求，輸入輸出數據都是以JSON格式。JSON對象用于描述想要做的事情是什么（創建主機，獲取圖像，更新監控項等）。
采用POST方法向http://example.com/zabbix/api_jsonrpc.php發送此JSON對象。http://example.com/zabbix/是Zabbix前端地址。api_jsonrpc.php是調用API的PHP腳本。可在安裝可視化前端的目錄下找到。
注：請求除了必須是POST方法之外，HTTP Header Content-Type必須為：application/jsonrequest，application/json-rpc，application/json其中之一。
可以采用腳本或者任何”手動”支持JSON RPC的工具來使用API。而首先需要了解的就是如何驗證和如何使用驗證ID來獲取想要的信息。后面的演示會以Python腳本的例子來呈現API的基本使用。
關于通信協議jsonrpc的介紹請參考文章：《通信協議jsonrpc》https://blog.csdn.net/zhouruifu2015/article/details/130249074
該圖表示使用Zabbix API時的典型數據流。身份驗證（方法user.login）是獲取身份驗證ID所需的強制性步驟。ID允許我們調用API的任何方法，前提是我們有足夠的權限。
該方法用于獲取Zabbix系統中的所有主機列表。可以通過指定過濾條件來限制返回的主機列表。
該方法用于獲取Zabbix系統中所有監控項的列表。可以通過指定過濾條件來限制返回的監控項列表。
該方法用于獲取Zabbix系統中所有觸發器的列表。可以通過指定過濾條件來限制返回的觸發器列表。
該方法用于獲取Zabbix系統中所有圖表的列表。可以通過指定過濾條件來限制返回的圖表列表。
該方法用于獲取Zabbix系統中某個監控項的歷史數據。可以通過指定過濾條件來限制返回的歷史數據。
這個方法允許根據給定的參數檢索發現的主機。
zabbix的API請求使用的協議是jsonrpc，所以請求參數的格式需要滿足jsonrpc的格式。以下是通過編程實現的一些示例
get_version.py
import requests
# python中的dict類型要轉換json格式的數據需要用到json庫
import json
# 要訪問的地址
url = 'http://{HOSTNAME}/zabbix/api_jsonrpc.php'
# 請求頭部信息
headers = {'Content-Type': 'application/json-rpc'}
data = {
# jsonrpc協議的版本號,固定的
"jsonrpc": "2.0",
# API調用方法，參考zabbix手冊，查詢zabbix版本
"method": "apiinfo.version",
# 沒有額外參數
"params": [],
# 對應的請求的標示符
"id": 1
}
# 使用requests發送請求,訪問指定網站,向url發送data請求,r收到的返回響應為json格式
# 將data轉成json格式,zabbix要求提交的數據是json格式
results = requests.post(url, headers=headers, data=json.dumps(data))
# 將json格式解碼,zabbix返回的數據都是json格式
print(results.status_code, results.json())輸出結果示例：
200 {‘jsonrpc’: ‘2.0’, ‘result’: ‘5.0.33’, ‘id’: 1}
在你可以訪問zabbix任何內部數據之前,你需要登錄并獲得身份驗證令牌，這個可以通過user.login方法來完成，任何Zabbix API客戶端在真正工作之前都需要驗證它自身。user.login這個方法接受一個用戶名和密碼作為參數并返回驗證ID，一個安全哈希串用于持續的API調用（在使用user.logout之前該驗證ID均有效）。
from http_request import http_post
# 導入封裝的網絡請求方法http_post
url = 'http://{HOSTNAME}/zabbix/api_jsonrpc.php'
username = 'Admin'
password = 'zabbix'
def user_login():
"""
用戶登錄，獲取token
"""
payload = {
"jsonrpc": "2.0",
"method": "user.login",
"params": {"user": username, "password": password},
"id": 1,
"auth": None,
}
resp = http_post(url, data=payload)
token = resp.get("result")
if not token:
print(u"Zabbix賬號密碼不正確，請輸入管理員賬號密碼")
return token
if __name__ == '__main__':
print(user_login())輸出結果示例：
754f3bf4fe41eff7e97b6e18027f6021
我們現在有一個有效的用戶身份驗證令牌，可用于在Zabbix中訪問數據。
from http_request import http_post
from get_token import user_login
author = user_login()
url = 'http://{HOSTNAME}/zabbix/api_jsonrpc.php'
data = {
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name"],
"hostids": "10084",
"search": {"key_": "system.cpu.util[,user]"}
},
"auth": author,
"id": 1
}
response = http_post(url, data=data)
# 輸出示例：{'jsonrpc': '2.0', 'result': [{'itemid': '29171', 'name': 'CPU user time'}], 'id': 1}
itemids = [item.get('itemid') for item in response.get('result', [])]
for itemid in itemids:
data = {
"jsonrpc": "2.0",
"method": "history.get",
"params": {
"output": "extend",
"itemids": itemid,
"history": 0,
"sortfield": "clock",
"sortorder": "DESC",
"limit": 1
},
"auth": author,
"id": 2
}
response = http_post(url, data=data)
# 輸出示例：{'jsonrpc': '2.0', 'result': [{'itemid': '29171', 'clock': '1682061011', 'value': '1.381076', 'ns': '272095768'}], 'id': 2}
print(response.get('result')[0]['value'])from zabbix_api.get_token import user_login, http_post
def host_create():
payload = {
"jsonrpc": "2.0",
"method": "host.create",
"params": {
"host": "server3",
"interfaces": [
{
"type": 1,
"main": 1,
"useip": 1,
"ip": "192.168.1.130",
"dns": "",
"port": "10050"
}
],
"groups": [
{
"groupid": "2"
}
],
"templates": [
{
"templateid": "10001"
}
]
},
"id": 2,
"auth": user_login()
}
resp = http_post(data=payload)
print('create mediatype', resp)
if __name__ == '__main__':
host_create()創建后的主機
import requests
from get_token import user_login
url = 'http://{HOSTNAME}/zabbix/api_jsonrpc.php'
headers = {'Content-Type': 'application/json-rpc'}
data = {
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "host"],
"selectInterfaces": ['interfaceid', "ip"]
},
"auth": user_login(),
"id": 1
}
response = requests.post(url, headers=headers, json=data)
print(response.json())輸出結果示例：
{‘jsonrpc’: ‘2.0’, ‘result’: [{‘hostid’: ‘10084’, ‘host’: ‘Zabbix server’, ‘interfaces’: [{‘interfaceid’: ‘1’, ‘ip’: ‘127.0.0.1’}]}], ‘id’: 1}
使用host.del還可以刪除主機，參數如下
{
"jsonrpc": "2.0",
"method": "host.del",
"params": [
"10307"
],
"id": 2,
"auth":"77962d5eaaf442111fe69cc3b9bc488e"
}from zabbix_api.get_token import user_login, http_post
def event_get():
payload = {
"jsonrpc": "2.0", "method": "event.get",
"params": {
"output": "extend",
"select_acknowledges": "extend",
"selectTags": "extend",
"selectSuppressionData": "extend",
"objectids": "13926",
"sortfield": ["clock", "eventid"],
"sortorder": "DESC"
},
"id": 1,
"auth": user_login()
}
resp = http_post(data=payload)
print('event_get', resp)
if __name__ == '__main__':
event_get()pyzabbix：pyzabbix?是一個?Python?模塊，它提供了一個簡單的接口來調用?Zabbix API。您可以在以下鏈接中找到?pyzabbix?的文檔和示例：https://pypi.org/project/pyzabbix/1.0.0/
以下是一個簡單的?Python?代碼示例，用于使用?pyzabbix?模塊連接到?Zabbix API?并獲取主機列表：
本示例代碼使用最新的Python3.11
from pyzabbix import ZabbixAPI
zabbix_server = 'http://{HOSTNAME}/zabbix/api_jsonrpc.php'
zabbix_user = "Admin"
zabbix_password = "zabbix"
zapi = ZabbixAPI(zabbix_server)
zapi.login(zabbix_user, zabbix_password)
hosts = zapi.host.get(output="extend")
for host in hosts:
print(host)
print(host["hostid"], host["host"])輸出結果
{‘hostid’: ‘10084’, ‘proxy_hostid’: ‘0’, ‘host’: ‘Zabbix server’, ‘status’: ‘0’, ‘disable_until’: ‘1684919414’, ‘error’: ‘Received empty response from Zabbix Agent at [127.0.0.1]. Assuming that agent dropped connection because of access permissions.’, ‘available’: ‘2’, ‘errors_from’: ‘1682070619’, ‘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’: ‘Zabbix server’, ‘flags’: ‘0’, ‘templateid’: ‘0’, ‘description’: ”, ‘tls_connect’: ‘1’, ‘tls_accept’: ‘1’, ‘tls_issuer’: ”, ‘tls_subject’: ”, ‘tls_psk_identity’: ”, ‘tls_psk’: ”, ‘proxy_address’: ”, ‘auto_compress’: ‘1’, ‘inventory_mode’: ‘-1’}
10084 Zabbix server
{‘hostid’: ‘10438’, ‘proxy_hostid’: ‘0’, ‘host’: ‘windows10’, ‘status’: ‘0’, ‘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’: ‘SteveRocket’, ‘flags’: ‘0’, ‘templateid’: ‘0’, ‘description’: ”, ‘tls_connect’: ‘1’, ‘tls_accept’: ‘1’, ‘tls_issuer’: ”, ‘tls_subject’: ”, ‘tls_psk_identity’: ”, ‘tls_psk’: ”, ‘proxy_address’: ”, ‘auto_compress’: ‘1’, ‘inventory_mode’: ‘-1’}
10438 windows10
{‘hostid’: ‘10439’, ‘proxy_hostid’: ‘0’, ‘host’: ‘VM-1-86-centos’, ‘status’: ‘0’, ‘disable_until’: ‘0’, ‘error’: ”, ‘available’: ‘1’, ‘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’: ‘VM-1-86-centos-1.86’, ‘flags’: ‘0’, ‘templateid’: ‘0’, ‘description’: ”, ‘tls_connect’: ‘1’, ‘tls_accept’: ‘1’, ‘tls_issuer’: ”, ‘tls_subject’: ”, ‘tls_psk_identity’: ”, ‘tls_psk’: ”, ‘proxy_address’: ”, ‘auto_compress’: ‘1’, ‘inventory_mode’: ‘-1’}
10439 VM-1-86-centos
通過封裝zabbix API，實現zabbix通過腳本的方式進行報警媒介通知，支持告警媒介的查詢、刪除、創建，以及創建消息模板，告警用戶的查詢、刪除、創建，動作的查詢、刪除、創建，用以接入第三方應用告警。
創建的動作與媒介和用戶進行綁定
zabbix_api/api_action.py
from zabbix_api.http_request import http_post
from zabbix_api import script_name, media_name, user_name, action_name, ACTION_MESSAGE_BODY
from zabbix_api.get_token import user_login
from zabbix_api.api_mediatype import mediatype_get
from zabbix_api.api_user import user_get
token = user_login()
PARAM = int("11")
def action_get():
payload = {
"jsonrpc": "2.0",
"method": "action.get",
"params": {
"output": "actionids",
"filter": {"name": action_name},
},
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('get action', resp)
return [i["actionid"] for i in resp["result"]]
def action_delete(action_ids):
"""
刪除mediatype
"""
payload = {"jsonrpc": "2.0", "method": "action.delete", "params": action_ids, "auth": token, "id": 1}
resp = http_post(data=payload)
print('delete action', resp)
def action_create():
"""創建觸發器"""
userid = user_get()
if userid and isinstance(userid, list):
userid = userid[0]
mediatypeid = mediatype_get()
if mediatypeid and isinstance(mediatypeid, list):
mediatypeid = mediatypeid[0]
payload = {
"jsonrpc": "2.0",
"method": "action.create",
"params": {
"name": action_name,
"eventsource": 0,
"status": 0,
"esc_period": 3600,
"def_shortdata": action_name + " {TRIGGER.NAME}: {TRIGGER.STATUS}",
"def_longdata": ACTION_MESSAGE_BODY,
"filter": {
"evaltype": 0,
"conditions": [
{
"conditiontype": 16,
"operator": PARAM,
"value": "",
},
],
},
"operations": [
{
"operationtype": 0,
"esc_period": 0,
"esc_step_from": 1,
"esc_step_to": 1,
"evaltype": 0,
"opmessage_usr": [{"userid": userid}],
"opmessage": {"default_msg": 1, "mediatypeid": mediatypeid},
}
],
},
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('create action', resp)
if __name__ == '__main__':
action_ids = action_get()
action_delete(action_ids)
action_create()通過API獲取報警媒介、刪除報警媒介、創建報警媒介腳本
zabbix_api/api_mediatype.py
from zabbix_api.http_request import http_post
from zabbix_api import script_name, media_name, action_name, ACTION_MESSAGE_BODY
from zabbix_api.get_token import user_login
token = user_login()
def mediatype_get():
"""
獲取mediatype
"""
payload = {
"jsonrpc": "2.0",
"method": "mediatype.get",
"params": {
"output": "mediatypeid",
"filter": {"description": media_name},
},
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('get mediatype', resp)
return [i["mediatypeid"] for i in resp["result"]]
def mediatype_delete(media_type_ids):
"""
刪除mediatype
"""
payload = {
"jsonrpc": "2.0",
"method": "mediatype.delete",
"params": media_type_ids,
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('delete mediatype', resp)
def mediatype_create():
"""
創建腳本
"""
exec_params = [
"{ALERT.MESSAGE}",
]
payload = {
"jsonrpc": "2.0",
"method": "mediatype.create",
"params": {
"name": media_name,
"description": media_name,
"exec_path": script_name,
"exec_params": "\r\n".join(exec_params) + "\r\n",
"type": 1,
"status": 0,
"message_templates": [
{
"eventsource": 0,
"recovery": 0,
"subject": action_name + " {TRIGGER.NAME}: {TRIGGER.STATUS}",
"message": ACTION_MESSAGE_BODY,
}
],
},
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('create mediatype', resp)
if __name__ == '__main__':
mediatype_ids = mediatype_get()
mediatype_delete(mediatype_ids)
mediatype_create()獲取報警媒介輸出結果：{‘jsonrpc’: ‘2.0’, ‘result’: [{‘mediatypeid’: ’29’}], ‘id’: 1}
刪除報警媒介輸出結果：{‘jsonrpc’: ‘2.0’, ‘result’: {‘mediatypeids’: [’29’]}, ‘id’: 1}
創建報警媒介輸出結果：{‘jsonrpc’: ‘2.0’, ‘result’: {‘mediatypeids’: [’30’]}, ‘id’: 1}
將創建的用戶和媒介進行關聯一起。
zabbix_api/api_user.py
from zabbix_api.http_request import http_post
from zabbix_api import password, usrgrpid, script_name, media_name, user_name, action_name, ACTION_MESSAGE_BODY
from zabbix_api.get_token import user_login
from zabbix_api.api_mediatype import mediatype_get
token = user_login()
def user_get():
"""
獲取以前老的mediatype
"""
payload = {
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "userid",
"filter": {"alias": user_name},
},
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('get user', resp)
return [i["userid"] for i in resp["result"]]
def user_delete(user_ids):
"""
刪除mediatype
"""
payload = {"jsonrpc": "2.0", "method": "user.delete", "params": user_ids, "auth": token, "id": 1}
resp = http_post(data=payload)
print("delete user", resp)
def user_create():
"""創建用戶"""
mediatypeid = mediatype_get()[0]
if mediatypeid and isinstance(mediatypeid, list):
mediatypeid = mediatypeid[0]
payload = {
"jsonrpc": "2.0",
"method": "user.create",
"params": {
"alias": user_name,
"name": user_name,
"surname": user_name,
"passwd": password,
"type": 3,
"usrgrps": [{"usrgrpid": usrgrpid}],
"user_medias": [
{
"mediatypeid": mediatypeid,
"sendto": user_name,
"active": 0,
"severity": 63,
"period": "1-7,00:00-24:00",
}
],
},
"auth": token,
"id": 1,
}
resp = http_post(data=payload)
print('create user', resp)
if __name__ == '__main__':
user_ids = user_get()
user_delete(user_ids)
user_create()創建主方法create_alarm_mediatype.py
from zabbix_api.api_mediatype import mediatype_get, mediatype_delete, mediatype_create
from zabbix_api.api_user import user_get, user_delete, user_create
from zabbix_api.api_action import action_get, action_delete, action_create
action_ids = action_get()
if action_ids:
action_delete(action_ids)
mediatype_ids = mediatype_get()
if mediatype_ids:
mediatype_delete(mediatype_ids)
user_ids = user_get()
if user_ids:
user_delete(user_ids)
mediatype_create()
user_create()
action_create()get action {‘jsonrpc’: ‘2.0’, ‘result’: [{‘actionid’: ’35’}], ‘id’: 1}
delete action {‘jsonrpc’: ‘2.0’, ‘result’: {‘actionids’: [’35’]}, ‘id’: 1}
get mediatype {‘jsonrpc’: ‘2.0’, ‘result’: [{‘mediatypeid’: ’36’}], ‘id’: 1}
delete mediatype {‘jsonrpc’: ‘2.0’, ‘result’: {‘mediatypeids’: [’36’]}, ‘id’: 1}
get user {‘jsonrpc’: ‘2.0’, ‘result’: [{‘userid’: ’36’}], ‘id’: 1}
delete user {‘jsonrpc’: ‘2.0’, ‘result’: {‘userids’: [’36’]}, ‘id’: 1}
create mediatype {‘jsonrpc’: ‘2.0’, ‘result’: {‘mediatypeids’: [’37’]}, ‘id’: 1}
get mediatype {‘jsonrpc’: ‘2.0’, ‘result’: [{‘mediatypeid’: ’37’}], ‘id’: 1}
create user {‘jsonrpc’: ‘2.0’, ‘result’: {‘userids’: [’37’]}, ‘id’: 1}
get user {‘jsonrpc’: ‘2.0’, ‘result’: [{‘userid’: ’37’}], ‘id’: 1}
get mediatype {‘jsonrpc’: ‘2.0’, ‘result’: [{‘mediatypeid’: ’37’}], ‘id’: 1}
create action {‘jsonrpc’: ‘2.0’, ‘result’: {‘actionids’: [36]}, ‘id’: 1}
執行成功后，查看創建的動作
代碼示例
from zabbix_api import username, password, url
import json
import datetime
import requests
from pyzabbix import ZabbixAPI
boturl = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=*****************"
headers = {'Content-Type': 'application/json;charset=utf-8'}
def msg(text):
json_text = {
"msgtype": "text",
"text": {
"content": text
},
}
print(requests.post(boturl, json.dumps(json_text), headers=headers).content)
def alert_msg():
# zabbix地址和登錄信息
ZABBIX_SERVER = url
zapi = ZabbixAPI(ZABBIX_SERVER)
zapi.login(username, password)
# 獲取告警信息
alert_list = zapi.trigger.get(
output=[
"triggerid", # 觸發器id
"description", # 觸發器內容描述
"priority", # 觸發器等級1-5 5最大 信息、警告、一般嚴重、嚴重、災難
],
filter={
"value": 1 # 過濾，此處表示啟動的觸發器
},
sortfield="priority", # 排序
sortorder="DESC", # 正排與倒排
min_severity=2, # 返回指定告警級別的告警，這里是大于等于告警
skipDependent=1, # 跳過依賴于其他問題中的觸發器
monitored=1, # 屬于受監控主機的已啟用觸發器，并僅包含已啟用的項目
active=1, # 只返回屬于受監控主機的啟用的觸發器（與上條意思差不多，至于什么區別，未測）
expandDescription=1, # 在觸發器的名稱中展開宏
selectHosts=['name'], # 在結果中返回關聯的主機信息（意思就是顯示出那臺主機告警的）
selectGroups=['name'], # 在結果中返回關聯的主機組信息（意思就是顯示出那個主機組告警的）
only_true=1 # 只返回最近處于問題狀態的觸發器
)
now_date = datetime.datetime.now()
info = ''
info += '當前存在告警：\n' + str(now_date)
for i in alert_list:
info += '\n\n名稱:' + i['hosts'][0]['name'] + '\n告警內容：' + i['description']
msg(info)
if '__main__' == __name__:
alert_msg()機器人收到的消息如下
使用Zabbix API可以讓用戶更方便地管理和監控Zabbix系統，同時還可以與其他應用程序進行集成。要使用Zabbix API，需要了解API的基本概念和方法，并了解如何使用API進行身份驗證和訪問。
Zabbix API：Zabbix?提供了?API，可以通過?Python?調用API?來操作?Zabbix。您可以在以下鏈接中找到有關Zabbix API?和?Python?的詳細信息：https://www.zabbix.com/documentation/current/manual/api
本文章轉載微信公眾號@CTO Plus