[comment]: # ({37c3aad7-37c3aad7})
# dhost.get

[comment]: # ({/37c3aad7-37c3aad7})

[comment]: # ({a1812e61-1309d6bb})
### 説明

`integer/array dhost.get(object parameters)`

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

::: noteclassic
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細は[ユーザーの役割](/manual/web_interface/frontend_sections/users/user_roles)を参照してください。
:::

[comment]: # ({/a1812e61-1309d6bb})

[comment]: # ({5f644960-061d7cf0})
### パラメータ

`(object)` 目的の出力を定義するパラメータ。

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

|パラメータ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|dhostids|ID/array|指定したIDを持つ検出済みホストのみを返します。|
|druleids|ID/array|指定したディスカバリルールによって作成された検出済みホストのみを返します。|
|dserviceids|ID/array|指定したサービスを実行している検出済みホストのみを返します。|
|selectDRules|query|ホストを検出したディスカバリルールの配列を含む [`drules`](/manual/api/reference/drule/object) プロパティを返します。|
|selectDServices|query|ホスト上で実行されている検出済みサービスを含む [`dservices`](/manual/api/reference/dservice/object) プロパティを返します。<br><br>`count` をサポートします。|
|limitSelects|integer|サブセレクトで返されるレコード数を制限します。<br><br>以下のサブセレクトに適用されます:<br>`selectDServices` - 結果は `dserviceid` でソートされます。|
|sortfield|string/array|指定したプロパティで結果をソートします。<br><br>指定可能な値: `dhostid`, `druleid`。|
|countOutput|boolean|これらのパラメータについては、[reference commentary](/manual/api/reference_commentary#common-get-method-parameters) で説明されています。|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5f644960-061d7cf0})

[comment]: # ({7223bab1-7223bab1})
### 戻り値

`(integer/array)` 次のいずれかを返します:

-   オブジェクトの配列
-   `countOutput`パラメーターが使用されている場合、取得したオブジェクトの数

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({c08efc78-4b9c1e99})
#### ディスカバリルールによって検出されたホストの取得

ディスカバリルール"4"によって検出されたすべてのホストと実行中の発見されたサービスを取得します。

[リクエスト](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "dhost.get",
    "params": {
        "output": "extend",
        "selectDServices": "extend",
        "druleids": "4"
    },
    "id": 1
}
```

レスポンス:

```json
{
    "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
}
```

[comment]: # ({/c08efc78-4b9c1e99})

[comment]: # ({184a9e84-e6b09247})
### 関連項目

-   [検出された
    サービス](/manual/api/reference/dservice/object#discovered-service)
-   [ディスカバリルール](/manual/api/reference/drule/object#discovery-rule)

[comment]: # ({/184a9e84-e6b09247})

[comment]: # ({8dc0c01a-8dc0c01a})
### ソース 

CDHost::get() in *ui/include/classes/api/services/CDHost.php*.

[comment]: # ({/8dc0c01a-8dc0c01a})