dhost.get
描述
integer/array dhost.get(object parameters)
该方法允许根据给定参数检索发现的主机
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅User roles
参数
(object) 定义所需输出的参数.
该方法支持以下参数.
| 参数 | 数据类型 | 描述 |
|---|---|---|
| dhostids | ID/array | 仅返回具有给定ID的已发现主机. |
| druleids | ID/array | 仅返回由给定发现规则创建的已发现主机. |
| dserviceids | ID/array | 仅返回运行给定服务的已发现主机. |
| selectDRules | query | 返回一个drules属性，包含检测到主机的发现规则的array. |
| selectDServices | query | 返回一个dservices属性，包含在主机上运行的已发现服务.支持 count. |
| limitSelects | integer | 限制子查询返回的记录数. 适用于以下子查询: selectDServices - 结果将按dserviceid排序. |
| sortfield | string/array | 按给定属性排序结果. 可能值: dhostid, druleid. |
| countOutput | boolean | 这些参数在通用get方法参数中有描述. |
| 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) 返回以下两种结果之一:
- 一个包含array的objects数组
- 检索到的objects数量（当使用了
countOutput参数时）
示例
通过发现规则检索已发现的主机
获取所有主机及其运行中通过发现规则"4"检测到的已发现服务。
执行请求:
{ "jsonrpc": "2.0", "method": "dhost.get", "params": { "output": "extend", "selectDServices": "extend", "druleids": "4" }, "id": 1 }响应:
{ "jsonrpc": "2.0", "result": [ { "dservices": [ { "dserviceid": "1", "dhostid": "1", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697227", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.1", "dns": "station.company.lan" } ], "dhostid": "1", "druleid": "4", "status": "0", "lastup": "1337697227", "lastdown": "0" }, { "dservices": [ { "dserviceid": "2", "dhostid": "2", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697234", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.4", "dns": "john.company.lan" } ], "dhostid": "2", "druleid": "4", "status": "0", "lastup": "1337697234", "lastdown": "0" }, { "dservices": [ { "dserviceid": "3", "dhostid": "3", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697234", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.26", "dns": "printer.company.lan" } ], "dhostid": "3", "druleid": "4", "status": "0", "lastup": "1337697234", "lastdown": "0" }, { "dservices": [ { "dserviceid": "4", "dhostid": "4", "type": "4", "key_": "", "value": "", "port": "80", "status": "0", "lastup": "1337697234", "lastdown": "0", "dcheckid": "5", "ip": "192.168.1.7", "dns": "mail.company.lan" } ], "dhostid": "4", "druleid": "4", "status": "0", "lastup": "1337697234", "lastdown": "0" } ], "id": 1 }另请参阅
来源
CDHost::get() 位于 ui/include/classes/api/services/CDHost.php 文件中。