hostgroup.get
描述
integer/array hostgroup.get(object parameters)
该方法允许根据给定参数检索主机组。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅User roles。
参数
(object) 定义所需输出的参数
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| graphids | ID/array | 仅返回包含指定图形的主机的主机组 |
| groupids | ID/array | 仅返回具有指定主机组 ID的主机组。 |
| hostids | ID/array | 仅返回包含给定主机的主机组 |
| maintenanceids | ID/array | 仅返回受指定维护影响的主机组。 |
| triggerids | ID/array | 仅返回包含给定触发器主机的主机组 |
| with_graphs | flag | 仅返回包含带图表主机的主机组。 |
| with_graph_prototypes | flag | 仅返回包含带有图形原型的主机的主机组。 |
| with_hosts | 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_hosts | flag | 仅返回包含受监控主机的主机组。 |
| with_monitored_items | flag | 仅返回包含已启用监控项的主机的主机组。 覆盖 with_simple_graph_items参数。 |
| with_monitored_triggers | flag | 仅返回包含已启用触发器主机的主机组。触发器中使用的所有监控项也必须处于启用状态。 |
| with_simple_graph_items | flag | 仅返回包含具有数值型监控项的主机的主机组。 |
| with_triggers | flag | 仅返回包含带触发器主机的主机组。 覆盖 with_monitored_triggers参数。 |
| selectDiscoveryRules | query | 返回包含发现主机组的LLD规则的discoveryRules属性。 |
| selectGroupDiscoveries | query | 返回一个带有主机组发现objects的groupDiscoveries属性。每个主机组发现object都是链接到被发现主机组的一个主机组原型，并具有以下属性： parent_group_prototypeid - 来自发现主机组的主机组原型的(ID) ID；name - 主机组原型的(string)名称；lastcheck - 主机组最后一次被发现时的(timestamp)时间；ts_delete - 不再被发现的主机组将被删除时的(timestamp)时间；status - 主机组发现状态的(int)：0 - (默认) 主机组被发现， 1 - 主机组不再被发现。 |
| selectHostPrototypes | query | 返回一个包含发现此主机组的主机原型的hostPrototypes属性 |
| selectHosts | query | 返回一个hosts属性，包含属于主机组的主机。支持 count。 |
| limitSelects | integer | 限制子查询返回的记录数量。 适用于以下子查询： selectHosts - 结果将按 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) 返回以下两种情况之一:
- 一个包含array的objects数组
- 检索到的objects数量，如果使用了
countOutput参数
示例
按名称检索数据
获取名为"Zabbix servers"和"Linux servers"的两个主机组的所有数据
执行请求:
{
"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",
"internal": "0"
},
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0"
}
],
"id": 1
}另请参阅
来源
CHostGroup::get() 位于 ui/include/classes/api/services/CHostGroup.php 文件中。