获取

描述

整数/数组 hostgroup.get(object **parameters**)

该方法允许根据指定的参数获取主机组

参数

(object) 定义期望输出的参数.

该方法支持以下参数:

参数类型描述
graphids字符串/数组返回包含具有给定图表的主机或模板的主机组.
groupids字符串/数组返回给定主机组ID的主机组.
hostids字符串/数组返回包含给定主机的主机组.
maintenanceids字符串/数组返回受指定维护影响的主机组.
monitored_hosts标识返回包含受监视主机的主机组.
real_hosts标识返回包含主机的主机组.
templated_hosts标识返回包含模板的主机组.
templateids字符串/数组返回包含给定模板的主机组.
triggerids字符串/数组返回包含给定触发器的主机或模板的主机组.
with_applications标识返回给定应用集包含主机的主机组.
with_graphs标识返回给定图表包含主机的主机组.
with_hosts_and_templates标识返回包含主机 模板的主机组.
with_httptests标识返回给定web检查包含主机的主机组.

覆盖with_monitored_httptests 参数.
with_items标识返回给定监控项包含主机或模板的主机组.

覆盖with_monitored_itemswith_simple_graph_items参数.
with_monitored_httptests标识返回启用web检查包含主机的主机组.
with_monitored_items标识返回给定启动监控项包含主机或模板的主机组.

覆盖with_simple_graph_items 参数.
with_monitored_triggers标识返回给定启用触发器包含主机的主机组. 触发器中使用的监控项必须事先已经启用.
with_simple_graph_items标识返回给定数字型监控项包含主机的主机组.
with_triggers标识返回给定触发器包含主机的主机组.

覆盖with_monitored_triggers参数.
selectDiscoveryRule查询discoveryRule属性中返回创建主机组的发现规则.
selectGroupDiscovery查询groupDiscovery属性中返回主机组发现对象.

主机组发现对象将发现的主机组链接到主机组原型,并具有以下属性:
groupid - (字符串) I已经发现主机组的ID;
lastcheck - (时间戳) 主机组最后一次被发现的时间;
name - (字符串) 主机组原型的名称;
parent_group_prototypeid - (字符串) 创建主机组的主机组原型的ID;
ts_delete - (时间戳) 主机组不再被发现删除的时间.
selectHosts查询hosts属性中返回归属主机组的主机.

支持 count.
selectTemplates查询tempaltes属性中返回归属主机组的模板.

支持 count.
limitSelects整数限制子选择返回的记录数.

适用于以下子选项:
selectHosts - 结果将按host排序;
selectTemplates - 结果将按host排序.
sortfield字符串/数组根据给定的属性排序.

可能值: groupid, name.
countOutput布尔值这些参数对于所有get方法都是通用的,详情可参考reference commentary.
editable布尔值
excludeSearch布尔值
filter对象
limit整数
output查询
preservekeys布尔值
search对象
searchByAny布尔值
searchWildcardsEnabled布尔值
sortorder字符串/数组
startSearch布尔值

返回值

(整数/数组) 返回:

  • 一组对象;

  • 如果使用了countOutput参数,返回对象的数量.

示例

根据名称获取数据

获取所有关于主机组Zabbix serversLinux servers的数据

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "hostgroup.get",
  4. "params": {
  5. "output": "extend",
  6. "filter": {
  7. "name": [
  8. "Zabbix servers",
  9. "Linux servers"
  10. ]
  11. }
  12. },
  13. "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0",
  14. "id": 1
  15. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "groupid": "2",
  6. "name": "Linux servers",
  7. "internal": "0"
  8. },
  9. {
  10. "groupid": "4",
  11. "name": "Zabbix servers",
  12. "internal": "0"
  13. }
  14. ],
  15. "id": 1
  16. }

参考

来源

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