hostgroup.get

説明

integer/array hostgroup.get(object parameters)

このメソッドは、与えられたパラメータに従って、host group を取得することができます。

このメソッドは、どのタイプのユーザーでも利用可能です。このメソッドを呼び出す許可は、ユーザーのロール設定で
取り消すことができます。詳しくはUser rolesをご覧ください。

パラメータ

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

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

パラメータ	タイプ	説明
graphids	string/array	指定されたグラフを持つホストまたはテンプレートを含むホストグループのみを返します。
groupids	string/array	指定されたホストグループ ID を持つホストグループのみを返します。
hostids	string/array	指定されたホストを含むホストグループのみを返します。
maintenanceids	string/array	指定されたメンテナンスの影響を受けるホストグループのみを返します。
monitored_hosts	flag	監視対象ホストを含むホストグループのみを返します。
real_hosts	flag	ホストを含むホストグループのみを返します。
templated_hosts	flag	テンプレートを含むホストグループのみを返します。
templateids	string/array	指定されたテンプレートを含むホストグループのみを返します。
triggerids	string/array	指定されたトリガーを持つホストまたはテンプレートを含むホストグループのみを返します。
with_graphs	flag	グラフのあるホストを含むホストグループのみを返します。
with_graph_prototypes	flag	グラフプロトタイプを持つホストを含むホストグループのみを返します。
with_hosts_and_templates	flag	ホストまたはテンプレートを含むホストグループのみを返します。
with_httptests	flag	Web チェックのあるホストを含むホストグループのみを返します。 `with_monitored_httptests` パラメータをオーバーライドします。
with_items	flag	アイテムを含むホストまたはテンプレートを含むホストグループのみを返します。 `with_monitored_items` および `with_simple_graph_items` パラメータをオーバーライドします。
with_item_prototypes	flag	アイテムプロトタイプを持つホストを含むホストグループのみを返します。 `with_simple_graph_item_prototypes` パラメータをオーバーライドします。
with_simple_graph_item_prototypes	flag	アイテムプロトタイプを持つホストを含むホストグループのみを返します。これは、作成が有効で、数値型の情報を持ちます。
with_monitored_httptests	flag	Web チェックが有効になっているホストを含むホストグループのみを返します。
with_monitored_items	flag	アイテムが有効になっているホストまたはテンプレートを含むホストグループのみを返します。 `with_simple_graph_items` パラメータをオーバーライドします。
with_monitored_triggers	flag	トリガーが有効になっているホストを含むホストグループのみを返します。トリガーで使用されるすべての項目も有効にする必要があります。
with_simple_graph_items	flag	数値項目を持つホストを含むホストグループのみを返します。
with_triggers	flag	トリガーを持つホストを含むホストグループのみを返します。 `with_monitored_triggers` パラメータをオーバーライドします。
selectDiscoveryRule	query	ホストグループを作成した LLD ルールを含む discoveryRule プロパティを返します。
selectGroupDiscovery	query	ホストグループディスカバリオブジェクトを含む`groupDiscovery`プロパティを返します。ホストグループディスカバリオブジェクトは、検出されたホストグループをホストグループプロトタイプにリンクし、次のプロパティを持ちます。 `groupid` - `(string)` 検出されたホストグループの ID。 `lastcheck` - `(timestamp)` ホストグループが最後に検出された時刻。 `name` - `(string)` ホストグループプロトタイプの名前。 `parent_group_prototypeid` - `(string)` ホストグループが作成されたホストグループプロトタイプの ID。 `ts_delete` - `(timestamp)` 検出されなくなったホストグループが削除される時刻。
selectHosts	query	ホストグループに属するホストを含む hosts プロパティを返します。 `count` をサポートします。
selectTemplates	query	ホストグループに属するテンプレートを含む templates プロパティを返します。 `count` をサポートします。
limitSelects	integer	副選択によって返されるレコードの数を制限します。次のサブセレクトに適用されます。 `selectHosts` - 結果は `host` でソートされます。 `selectTemplates` - 結果は `host` でソートされます。
sortfield	string/array	指定されたプロパティで結果を並べ替えます。使用可能な値は次のとおりです: `groupid`、`name`
countOutput	boolean	すべての`get`メソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。
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 パラメータが使用されている場合は、取得したオブジェクトの数

例

名前によるデータの取得

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

リクエスト:

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

レスポンス:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               },
               {
                   "groupid": "4",
                   "name": "Zabbix servers",
                   "internal": "0"
               }
           ],
           "id": 1
       }

参照

ソース

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

Documentation

hostgroup.get

説明

パラメータ

戻り値

例

名前によるデータの取得

参照

ソース