dservice.get

説明

integer/array dservice.get(object parameters)

このメソッドは、指定したパラメーターに応じた検出されたサービスを取得できます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメータ

(object) 望ましい出力を定義するパラメータ。

このメソッドは以下のパラメータをサポートします。

パラメータ 型 説明
dserviceids ID/array 指定したIDの検出サービスのみを返します。
dhostids ID/array 指定した検出ホストに属する検出サービスのみを返します。
dcheckids ID/array 指定した検出チェックによって検出された検出サービスのみを返します。
druleids ID/array 指定した検出ルールによって検出された検出サービスのみを返します。
selectDRules query サービスを検出した検出ルールの配列を持つdrulesプロパティを返します。
selectDHosts query サービスが属する検出ホストの配列を持つdhostsプロパティを返します。
selectHosts query サービスと同じIPアドレスおよびプロキシを持つホストのhostsプロパティを返します。

countをサポートします。
limitSelects integer サブセレクトによって返されるレコード数を制限します。

以下のサブセレクトに適用されます:
selectHosts - 結果はhostidでソートされます。
sortfield string/array 指定したプロパティで結果をソートします。

可能な値: dserviceid, dhostid, ip。
countOutput boolean これらのパラメータはリファレンス解説で説明されています。
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.