获取

获取

描述

integer/array dservice.get(object parameters)

此方法允许根据给定的参数检索被发现的服务。

此方法对任何类型的用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看用户角色。

参数

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

此方法支持以下参数。

参数	类型	描述
dserviceids	string/array	仅返回具有给定 ID 的被发现对象。
dhostids	string/array	仅返回属于给定被发现主机的被发现对象。
dcheckids	string/array	仅返回被给定发现检查检测出的被发现对象。
druleids	string/array	仅返回被给定发现规则检测出的被发现对象。
selectDRules	query	返回包含检测到服务的发现规则数组的 drules 属性。
selectDHosts	query	返回包含服务所属的被发现主机数组的 dhosts 属性。
selectHosts	query	返回与服务具有相同 IP 地址和代理的主机的 hosts 属性。支持 `count`。
limitSelects	integer	限制子选择返回的记录数。适用于以下子选择： `selectHosts` - 结果将按 `hostid` 排序。
sortfield	string/array	按照给定属性对结果进行排序。可用值：`dserviceid`、`dhostid` 和 `ip`。
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，则返回检索到的对象的数量。

示例

检索在主机上被发现的服务

检索在被发现主机“11”上检测出的所有被发现的服务。

请求：

{
           "jsonrpc": "2.0",
           "method": "dservice.get",
           "params": {
               "output": "extend",
               "dhostids": "11"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应：

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dserviceid": "12",
                   "dhostid": "11",
                   "value": "",
                   "port": "80",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650607",
                   "dcheckid": "5",
                   "ip": "192.168.1.134",
                   "dns": "john.local"
               },
               {
                   "dserviceid": "13",
                   "dhostid": "11",
                   "value": "",
                   "port": "21",
                   "status": "1",
                   "lastup": "0",
                   "lastdown": "1348650610",
                   "dcheckid": "6",
                   "ip": "192.168.1.134",
                   "dns": "john.local"
               }
           ],
           "id": 1
       }

参见

来源

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