[comment]: # ({f8d4c2e5-f8d4c2e5})
# hostgroup.get

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

[comment]: # ({20294517-08ff22f2})
### 説明

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

このメソッドでは、指定されたパラメータに従ってホストグループを取得できます。

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

[comment]: # ({/20294517-08ff22f2})

[comment]: # ({5291ff51-7f042696})
### パラメータ

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

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|graphids|ID/array|指定したグラフを持つホストを含むホストグループのみを返します。|
|groupids|ID/array|指定したホストグループIDを持つホストグループのみを返します。|
|hostids|ID/array|指定したホストを含むホストグループのみを返します。|
|maintenanceids|ID/array|指定したメンテナンスの影響を受けるホストグループのみを返します。|
|triggerids|ID/array|指定したトリガーを持つホストを含むホストグループのみを返します。|
|with\_graphs|boolean|グラフを持つホストを含むホストグループのみを返します。|
|with\_graph\_prototypes|boolean|グラフプロトタイプを持つホストを含むホストグループのみを返します。|
|with\_hosts|boolean|ホストを含むホストグループのみを返します。|
|with\_httptests|boolean|Web監視を持つホストを含むホストグループのみを返します。<br><br>`with_monitored_httptests` パラメータを上書きします。|
|with\_items|boolean|アイテムを持つホストを含むホストグループのみを返します。<br><br>`with_monitored_items` および `with_simple_graph_items` パラメータを上書きします。|
|with\_item\_prototypes|boolean|アイテムプロトタイプを持つホストを含むホストグループのみを返します。<br><br>`with_simple_graph_item_prototypes` パラメータを上書きします。|
|with\_simple\_graph\_item\_prototypes|boolean|作成が有効で、かつ数値型の情報タイプを持つアイテムプロトタイプを含むホストを持つホストグループのみを返します。|
|with\_monitored\_httptests|boolean|有効なWeb監視を持つホストを含むホストグループのみを返します。|
|with\_monitored\_hosts|boolean|監視対象のホストを含むホストグループのみを返します。|
|with\_monitored\_items|boolean|有効なアイテムを持つホストを含むホストグループのみを返します。<br><br>`with_simple_graph_items` パラメータを上書きします。|
|with\_monitored\_triggers|boolean|有効なトリガーを持つホストを含むホストグループのみを返します。トリガーで使用されるすべてのアイテムも有効である必要があります。|
|with\_simple\_graph\_items|boolean|数値型のアイテムを持つホストを含むホストグループのみを返します。|
|with\_triggers|boolean|トリガーを持つホストを含むホストグループのみを返します。<br><br>`with_monitored_triggers` パラメータを上書きします。|
|selectDiscoveryRules|query|ホストグループを検出したLLDルールを含む [`discoveryRules`](/manual/api/reference/discoveryrule/object) プロパティを返します。|
|selectDiscoveryData|query|ホストグループ検出オブジェクトを含む `discoveryData` プロパティを返します。<br><br>各ホストグループ検出オブジェクトは、検出されたホストグループにリンクされたホストグループプロトタイプであり、以下のプロパティを持ちます。<br>`parent_group_prototypeid` - `(ID)` ホストグループの検出元となったホストグループプロトタイプのID;<br>`name` - `(string)` ホストグループプロトタイプの名前;<br>`ts_delete` - `(timestamp)` すでに検出されなくなったホストグループが削除される時刻;<br>`status` - `(int)` ホストグループの検出ステータス:<br>0 - *(default)* ホストグループは検出されている,<br>1 - ホストグループはすでに検出されていない。|
|selectHostPrototypes|query|このホストグループを検出したホストプロトタイプを含む [`hostPrototypes`](/manual/api/reference/hostprototypes/object) プロパティを返します。|
|selectHosts|query|ホストグループに属するホストを含む [`hosts`](/manual/api/reference/host/object) プロパティを返します。<br><br>`count` をサポートします。|
|limitSelects|integer|サブセレクトで返されるレコード数を制限します。<br><br>以下のサブセレクトに適用されます:<br>`selectHosts` - 結果は `host` でソートされます。|
|sortfield|string/array|指定したプロパティで結果をソートします。<br><br>指定可能な値: `groupid`, `name`。|
|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|^|
|selectGroupDiscoveries|query|ホストグループ検出オブジェクトを含む `groupDiscoveries` プロパティを返します。<br><br>各ホストグループ検出オブジェクトは、検出されたホストグループにリンクされたホストグループプロトタイプです。<br><br>このクエリは**非推奨**です。代わりに `selectDiscoveryData` を使用してください。|

[comment]: # ({/5291ff51-7f042696})

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

`(integer/array)` 以下のいずれかを返します。

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

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

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

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

[comment]: # ({6271b06c-8ed2756a})
#### 名前によるデータの取得

"Zabbix servers" および "Linux servers" という名前の2つのホストグループに関するすべてのデータを取得します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "hostgroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Zabbix servers",
                "Linux servers"
            ]
        }
    },
    "id": 1
}
```

レスポンス:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}
```

[comment]: # ({/6271b06c-8ed2756a})

[comment]: # ({6a994b89-e5f0abe1})
### 関連項目

-   [ホスト](/manual/api/reference/host/object#host)

[comment]: # ({/6a994b89-e5f0abe1})

[comment]: # ({1e72ea39-1e72ea39})
### ソース

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

[comment]: # ({/1e72ea39-1e72ea39})