Documentation
Table of Contents
dservice.get
説明
integer/array dservice.get(object parameters)
このメソッドは、指定したパラメーターに応じた検出されたサービスを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) 希望する出力を定義するパラメータ
このメソッドは、以下のパラメータをサポートしています。
| パラメータ | Type | 説明 |
|---|---|---|
| dserviceids | string/array | Return only discovered services with the given IDs. |
| dhostids | string/array | Return only discovered services that belong to the given discovered hosts. |
| dcheckids | string/array | Return only discovered services that have been detected by the given discovery checks. |
| druleids | string/array | Return only discovered services that have been detected by the given discovery rules. |
| selectDRules | query | Return a drules property with an array of the discovery rules that detected the service. |
| selectDHosts | query | Return a dhosts property with an array the discovered hosts that the service belongs to. |
| selectHosts | query | Return a hosts property with the hosts with the same IP address and proxy as the service. Supports count. |
| limitSelects | integer | Limits the number of records returned by subselects. Applies to the following subselects: selectHosts - result will be sorted by hostid. |
| sortfield | string/array | Sort the result by the given properties. Possible values are: dserviceid, dhostid and ip. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary. |
| 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" }, "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 }参照
ソース
CDService::get() in ui/include/classes/api/services/CDService.php.