hostgroup.get

説明

integer/array hostgroup.get(object parameters)

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

パラメータ

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

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

戻り値

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

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

例

名前によるデータの取得

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

リクエスト:

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

レスポンス:

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

関連項目

• ホスト

ソース

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