Documentation
获取
描述
integer/array hostinterface.get(object parameters)
此方法允许获取给定参数的主机接口记录。
::: noteclassic 该方法适用于管理员和超级管理员用户类型。可以在用户角色设置中撤销调用该方法的权限。有关详细信息，参阅用户角色。:::
参数
(object)定义期望输出的参数。
该方法支持以下参数：
| 参数 | 类型 | 描述 |
|---|---|---|
| hostids | 字符串/数组 | 返回给定主机使用的主机接口。 |
| interfaceids | 字符串/数组 | 返回给定ID的主机接口。 |
| itemids | 字符串/数组 | 返回给定监控项使用的主机接口。 |
| triggerids | 字符串/数组 | 返回给定的触发器中监控项使用的主机接口。 |
| selectItems | 查询 | 返回监控项 属性。其中包括使用该接口的监控项 支持 count. |
| selectHosts | 查询 | 返回 主机属性，其中包括使用该接口的主机数组。 |
| limitSelects | 整型 | 限制子选择返回的记录数 适用于以下子选择: selectItems。 |
| sortfield | 字符串/数组 | 对给定属性的结果进行排序。 可能的值有: interfaceid, dns, ip。 |
| countOutput | 布尔值 | 该参数对于参考注释页面中所有get详细描述的方法都适用。 |
| editable | 布尔值 | |
| excludeSearch | 布尔值 | |
| filter | 对象 | |
| limit | 整型 | |
| nodeids | 字符串/数组 | |
| output | 查询 | |
| preservekeys | 布尔值 | |
| search | 对象 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 |
返回值
(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.