zabbix --- API

概览

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提供一套完全不同的一组方法。

执行请求

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

curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{"jsonrpc":"2.0","method":"apiinfo.version","id":1,"auth":null,"params":{}}
' http://172.25.254.1/zabbix/api_jsonrpc.php
请求的 Content-Type 头部必须设置为以下值之一： application/json-rpc, application/json 或 application/jsonrequest。 

验证

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

curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
        "jsonrpc": "2.0",
        "method": "user.login",
        "params": {
                "user": "Admin",
                "password": "zabbix"
        },
        "id": 1,
        "auth": null
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool

让我们仔细看看示例请求对象。它具有以下属性：

• jsonrpc - API使用的JSON-RPC协议的版本; Zabbix API实现的JSON-RPC版本是2.0;
• method - 被调用的API方法名;
• params - 将被传递给API方法的参数;
• id - 请求的任意标识符;
• auth -用户认证令牌; 因为我们还没有一个，它的设置null。

如果你正确提供了凭据，API返回的响应将包含用户身份验证令牌：

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": "636393eceb6b8d3e2f7202996a67a205"
}

响应对象又包含以下属性：

jsonrpc - JSON-RPC协议的版本;
result - 方法返回的数据;
id - 相应请求的标识符。

检索主机

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

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": "636393eceb6b8d3e2f7202996a67a205"
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool

• 请注意， auth 属性现在设置为我们通过调用user.login方法获得的身份验证令牌。

响应对象将包含有关主机的请求的数据：

{
    "id": 2,
    "jsonrpc": "2.0",
    "result": [
        {
            "host": "Zabbix server",
            "hostid": "10084",
            "interfaces": [
                {
                    "interfaceid": "1",
                    "ip": "127.0.0.1"
                }
            ]
        },
        {
            "host": "server2",
            "hostid": "10265",
            "interfaces": [
                {
                    "interfaceid": "4",
                    "ip": "172.25.254.2"
                }
            ]
        }
    ]
}

创建主机

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

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.254.2",
                "dns": "",
                "port": "10050"
            }
        ],
        "groups": [
            {
                "groupid": "2"
            }
        ],
        "templates": [
            {
                "templateid": "10001"
            }
        ]
    },
    "auth": "636393eceb6b8d3e2f7202996a67a205",
    "id": 1
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool

响应

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10267"
        ]
    }
}

删除主机

请求：

curl -s -XPOST -H "Content-Type: application/json-rpc" -d '
{
    "jsonrpc": "2.0",
    "method": "host.delete",
    "params": [
        "10265"
    ],
    "auth": "636393eceb6b8d3e2f7202996a67a205"
}' http://172.25.254.1/zabbix/api_jsonrpc.php | python -m json.tool

响应

{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
         	"10265"
        ]
    },
    "id": 1
}