获取
描述
integer/array hostinterface.get(object parameters)
此方法允许获取给定参数的主机接口记录。
::: noteclassic 该方法适用于管理员和超级管理员用户类型。可以在用户角色设置中撤销调用该方法的权限。有关详细信息，参阅用户角色。:::
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| hostids | string/array | 只返回由指定主机使用的主机接口。 |
| interfaceids | string/array | 只返回具有给定ID的主机接口。 |
| itemids | string/array | 只返回由指定监控项使用的主机接口。 |
| triggerids | string/array | 只返回由给定触发器中的监控项使用的主机接口。 |
| selectItems | query | 返回一个监控项属性，包含使用该接口的监控项。 支持 count。 |
| selectHosts | query | 返回一个主机属性，包含使用该接口的主机数组。 |
| limitSelects | integer | 限制子查询返回的记录数。 适用于以下子查询： selectItems。 |
| sortfield | string/array | 根据给定属性对结果进行排序。 可能的值包括： interfaceid, dns, ip。 |
| countOutput | boolean | 这些参数对于所有获取方法都是通用的，在参考说明页面中有详细描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回:
- 一组对象;
- 如果设置了
countOutput参数,则返回获取到的对象数量。
示例
获取主机接口
获取ID为30057的主机使用的接口所有数据。
请求:
{
"jsonrpc": "2.0",
"method": "hostinterface.get",
"params": {
"output": "extend",
"hostids": "30057"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"interfaceid": "50039",
"hostid": "30057",
"main": "1",
"type": "1",
"useip": "1",
"ip": "::1",
"dns": "",
"port": "10050",
"available": "0",
"error": "",
"errors_from": "0",
"disable_until": "0",
"details": []
},
{
"interfaceid": "55082",
"hostid": "30057",
"main": "0",
"type": "1",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10051",
"available": "0",
"error": "",
"errors_from": "0",
"disable_until": "0",
"details": {
"version": "2",
"bulk": "0",
"community": "{$SNMP_COMMUNITY}"
}
}
],
"id": 1
}参考
来源
CHostInterface::get() in ui/include/classes/api/services/CHostInterface.php.