获取

获取

描述

integer/array dhost.get(object parameters)

这个方法允许根据给定的参数检索发现的主机。

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

参数

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

此方法支持以下参数。

参数	类型	描述
dhostids	ID/array	仅返回具有给定ID的已发现主机。
druleids	ID/array	仅返回已由给定发现规则创建的已发现主机。
dserviceids	ID/array	仅返回运行给定服务的已发现主机。
selectDRules	query	返回一个drules属性，其中包括检测到主机的发现规则数组。
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) 返回其中一种结果：

一个对象数组；
如果使用了参数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
       }

参见

来源

ui/include/classes/api/services/CDHost.php 中的 CDHost::get()。