获取

描述

integer/array hostinterface.get(object parameters)

该方法允许根据给定参数检索主机接口。

任何类型的用户都可以使用该方法。调用该方法的权限可在用户角色设置中撤销。 更多信息请参阅 用户角色。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数类型说明
hostidsID/array只返回给定主机使用的主机接口。
interfaceidsID/array只返回具有给定 ID 的主机接口。
itemidsID/array只返回给定监控项使用的主机接口。
triggeridsID/array只返回给定触发器中的项目所使用的主机接口。
selectItemsquery返回一个 监控项 属性，其中包含使用该接口的监控项。

支持 count.
selectHostsquery返回一个 主机 属性，其中包含一个使用该接口的主机的数组。
limitSelectsinteger限制子选择返回的记录数。

适用于以下子选择：
selectItems.
sortfieldstring/array根据给定的属性对结果进行排序。

可能的值： interfaceid, dns, ip.
countOutputboolean这些参数是所有 get 方法的通用参数，详见 参考评注 页面。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回二者之一：

  • 一个对象数组；
  • 如果使用了 countOutput 参数，则读取的对象数量。

示例

检索主机接口

检索主机 “30057 “所使用接口的所有数据。

请求：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "hostinterface.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "hostids": "30057"
  7.            },
  8.            "id": 1
  9.        }

响应：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "interfaceid": "50039",
  6.                    "hostid": "30057",
  7.                    "main": "1",
  8.                    "type": "1",
  9.                    "useip": "1",
  10.                    "ip": "::1",
  11.                    "dns": "",
  12.                    "port": "10050",
  13.                    "available": "0",
  14.                    "error": "",
  15.                    "errors_from": "0",
  16.                    "disable_until": "0",
  17.                    "details": []
  18.                },
  19.                {
  20.                    "interfaceid": "55082",
  21.                    "hostid": "30057",
  22.                    "main": "0",
  23.                    "type": "1",
  24.                    "useip": "1",
  25.                    "ip": "127.0.0.1",
  26.                    "dns": "",
  27.                    "port": "10051",
  28.                    "available": "0",
  29.                    "error": "",
  30.                    "errors_from": "0",
  31.                    "disable_until": "0",
  32.                    "details": {
  33.                        "version": "2",
  34.                        "bulk": "0",
  35.                        "community": "{$SNMP_COMMUNITY}"
  36.                    }
  37.                }
  38.            ],
  39.            "id": 1
  40.        }

另见

来源

CHostInterface::get() 在 ui/include/classes/api/services/CHostInterface.php.