获取

描述

integer/array templategroup.get(object parameters)

该方法允许根据给定的参数检索模板组.

任何类型的用户都可以使用此方法。可以在用户角色设置中撤销调用该方法的权限. 更多信息请查看用户角色.

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 类型 描述
graphids ID/数组 仅返回包含具有指定图表的模板的模板组。
groupids ID/数组 仅返回具有指定模板组ID的模板组。
templateids ID/数组 仅返回包含指定模板的模板组。
triggerids ID/数组 仅返回包含具有指定触发器的模板的模板组。
with_graphs 标记 仅返回包含具有图表的模板的模板组。
with_graph_prototypes 标记 仅返回包含具有图表原型的模板的模板组。
with_httptests 标记 仅返回包含具有网络检查的模板的模板组。
with_items 标记 仅返回包含具有监控项的模板的模板组。

覆盖 with_simple_graph_items 参数。
with_item_prototypes 标记 仅返回包含具有监控项原型的模板的模板组。

覆盖 with_simple_graph_item_prototypes 参数。
with_simple_graph_item_prototypes 标记 仅返回包含具有监控项原型的模板的模板组,这些监控项原型启用创建且具有数值类型的信息。
with_simple_graph_items 标记 仅返回包含具有数值监控项的模板的模板组。
with_templates 标记 仅返回包含模板的模板组。
with_triggers 标记 仅返回包含具有触发器的模板的模板组。
selectTemplates 查询 返回一个 templates 属性,其中包含属于模板组的模板。

支持 count
limitSelects 整数 限制子查询返回的记录数量。

适用于以下子查询:
selectTemplates - 结果将按 template 排序。
sortfield 字符串/数组 根据给定属性对结果进行排序。

可能的值:groupid, name
countOutput 布尔值 这些参数在 参考说明 中有描述。
editable 布尔值
excludeSearch 布尔值
filter 对象
limit 整数
output 查询
preservekeys 布尔值
search 对象
searchByAny 布尔值
searchWildcardsEnabled 布尔值
sortorder 字符串/数组
startSearch 布尔值

返回值

(integer/array) 返回两者其一:

  • 一个对象数组;
  • 如果使用了'countOutput'参数,则对检索对象进行计数。

示例

按照名字检索模板组

检索名为 "Templates/Databases"和 "Templates/Modules"的两个模板组的数据.

请求:

{
           "jsonrpc": "2.0",
           "method": "templategroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Templates/Databases",
                       "Templates/Modules"
                   ]
               }
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "13",
                   "name": "Templates/Databases",
                   "uuid": "748ad4d098d447d492bb935c907f652f"
               },
               {
                   "groupid": "8",
                   "name": "Templates/Modules",
                   "uuid": "57b7ae836ca64446ba2c296389c009b7"
               }
           ],
           "id": 1
       }

参阅

来源

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