Documentation
dhost.get
描述
integer/array dhost.get(object parameters)
这个方法允许根据给定的参数检索发现的主机。
任何类型的用户都可以使用此方法。可以在用户角色设置中撤销调用该方法的权限。参见用户角色 了解更多信息。
参数
(object) 定义需要输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| dhostids | 字符串/数组 | 只返回给定ID的被发现的主机 |
| druleids | 字符串/数组 | 只返回发现规则创建的已发现主机。 |
| dserviceids | 字符串/数组 | 只返回指定服务的已发现主机。 |
| selectDRules | 查询 | 返回一个drules属性，其中包括检测到主机发现规则数组。 |
| selectDServices | 查询 | 返回dservices属性，发现的服务在主机上运行。 支持 count。 |
| limitSelects | 整数 | 限制子选项返回的记录数 用于如下的子选项: selectDServices - 结果会按照 dserviceid排序。 |
| sortfield | 字符串/数组 | 按照给出的属性对结果进行排序。 可能的值: dhostid 和 druleid. |
| countOutput | 布尔值 | 参考评论中详细描述了所有“get”方法通用的这些参数。 |
| editable | 布尔值 | |
| excludeSearch | 布尔值 | |
| filter | 对象 | |
| limit | 整数 | |
| output | 查询 | |
| preservekeys | 布尔值 | |
| search | 对象 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 |
返回值
(integer/array) 返回:
- 一组对象;
- 如果使用了
countOutput参数，返回检索对象的数量。
示例
通过发现规则检索发现的主机
检索发现规则"4"检测到的所有主机及其正在运行的已发现服务。
请求:
{ "jsonrpc": "2.0", "method": "dhost.get", "params": { "output": "extend", "selectDServices": "extend", "druleids": "4" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "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() in ui/include/classes/api/services/CDHost.php.