获取

Description 说明

integer/array template.get(object parameters)

The method allows to retrieve templates according to the given parameters. 此方法允许根据指定的参数检索模板。

Parameters 参数

(object) Parameters defining the desired output. (object)定义需要输出的参数。

The method supports the following parameters. 此方法支持以下参数。

Parameter 参数 Tpe 类型 Desription 说明
templateidsstring/array 字符串/数组 Retun only templates with the given template IDs. 只返回指定模板ID的模板。
groupidsstring/array 字符串/数组 Retun only templates that belong to the given host groups. 只返回指定主机组所属的模板。
parentTemplateidsstring/array 字符串/数组 Retun only templates that are children of the given templates. 只返回指定子类模板的模板。
hostidsstring/array 字符串/数组 Retun only templates that are linked to the given hosts. 只返回被链接到指定主机的模板。
graphidsstring/array 字符串/数组 Retun only templates that contain the given graphs. 只返回包含指定图形的模板。
itemidsstring/array 字符串/数组 Retun only templates that contain the given items. 只返回包含指定监控项的模板。
triggeridsstring/array 字符串/数组 Retun only templates that contain the given triggers. 只返回包含指定触发器的模板。
with_itemsflag 标记 Rturn only templates that have items. 只返回具有监控项的模板。
with_triggersflag 标记 Rturn only templates that have triggers. 只返回具有触发器的模板。
with_graphsflag 标记 Rturn only templates that have graphs. 只返回具有图形的模板。
with_httptestsflag 标记 Rturn only templates that have web scenarios. 只返回具有web场景的模板。
selectGroupsquery 查询 Rturn the host groups that the template belongs to in the groups property. 从groups属性中返回所属模板的主机组。
selectHostsquery 查询 Rturn the hosts that are linked to the template in the hosts property. 从hosts属性中返回被链接模板的主机。

Supports count. 支持count。
selectTemplatesquery 查询 Rturn the child templates in the templates property. 从templates属性中返回子类模板。

Supports count. 支持count。
selectParentTemplatesquery 查询 Rturn the parent templates in the parentTemplates property. 从parentTemplates属性中返回父类模板。

Supports count. 支持count。
selectHttpTestsquery 查询 Rturn the web scenarios from the template in the httpTests property. 从httpTests属性中返回来自模板的web场景。

Supports count. 支持count。
selectItemsquery 查询 Rturn items from the template in the items property. 从items属性中返回来自模板的监控项。

Supports count. 支持count。
selectDiscoveriesquery 查询 Rturn low-level discoveries from the template in the discoveries property. 从discoveries属性中返回来自模板的低级别发现。

Supports count. 支持count。
selectTriggersquery 查询 Rturn triggers from the template in the triggers property. 从triggers属性中返回来自模板的触发器。

Supports count. 支持count。
selectGraphsquery 查询 Rturn graphs from the template in the graphs property. 从graphs属性中返回来自模板的图表。

Supports count. 支持count。
selectApplicationsquery 查询 Rturn applications from the template in the applications property. 从applications属性中返回来自模板的应用。

Supports count. 支持count。
selectMacrosquery 查询 Rturn the macros from the template in the macros property. 从macros属性中返回来自模板的宏。
selectScreensquery 查询 Rturn screens from the template in the screens property. 从screens属性中返回来自模板的聚合图形。

Supports count. 支持count。
limitSelectsinteger 整数型 Liits the number of records returned by subselects. 限制子查询返回的记录数。

Applies to the following subselects: 应用于以下子查询：
selectTemplates - results will be sorted by name; 结果将以name排序；
selectHosts - sorted by host; 以host排序；
selectParentTemplates - sorted by host; 以host排序；
selectItems - sorted by name; 以name排序；
selectDiscoveries - sorted by name; 以name排序；
selectTriggers - sorted by description; 以description排序；
selectGraphs - sorted by name; 以name排序；
selectApplications - sorted by name; 以name排序；
selectScreens - sorted by name. 以name排序；
sortfieldstring/array 字符串/数组 Sortthe result by the given properties. 根据给定的属性为结果排序。

Possible values are: hostid, host, name, status. 许可值为：hostid,host,name,status。
countOutputboolean 布尔值 Thse parameters being common for all get methods are described in detail in the reference commentary. 这些参数十分普遍，适用所有get方法，详情参见reference commentary。
editableboolean 布尔值 ::
excludeSearchboolean 布尔值 ::
filterobject 对象 ::
limitinteger 整数型 ::
outputquery 查询 ::
preservekeysboolean 布尔值 ::
searchobject 对象 ::
searchByAnyboolean 布尔值 ::
searchWildcardsEnabledboolean 布尔值 ::
sortorderstring/array 字符串/数组 :::
startSearchboolean 布尔值 ::

Return values 返回值

(integer/array) Returns either: (integer/array)返回两者其中任一：

  • an array of objects; 一组对象；
  • the count of retrieved objects, if the countOutput parameter has been used. 如果已经使用了countOutput参数，则检索对象的计数。

Examples 范例

Retrieving templates by name 按名称检索模板

Retrieve all data about two templates named “Template OS Linux” and “Template OS Windows”. 检索名称为”Template OS Linux”和”Template OS Windows”这两个模板的所有数据。 Request 请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "template.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "filter": {
  7.                    "host": [
  8.                        "Template OS Linux",
  9.                        "Template OS Windows"
  10.                    ]
  11.                }
  12.            },
  13.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  14.            "id": 1
  15.        }

Response 响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "proxy_hostid": "0",
  6.                    "host": "Template OS Linux",
  7.                    "status": "3",
  8.                    "disable_until": "0",
  9.                    "error": "",
  10.                    "available": "0",
  11.                    "errors_from": "0",
  12.                    "lastaccess": "0",
  13.                    "ipmi_authtype": "0",
  14.                    "ipmi_privilege": "2",
  15.                    "ipmi_username": "",
  16.                    "ipmi_password": "",
  17.                    "ipmi_disable_until": "0",
  18.                    "ipmi_available": "0",
  19.                    "snmp_disable_until": "0",
  20.                    "snmp_available": "0",
  21.                    "maintenanceid": "0",
  22.                    "maintenance_status": "0",
  23.                    "maintenance_type": "0",
  24.                    "maintenance_from": "0",
  25.                    "ipmi_errors_from": "0",
  26.                    "snmp_errors_from": "0",
  27.                    "ipmi_error": "",
  28.                    "snmp_error": "",
  29.                    "jmx_disable_until": "0",
  30.                    "jmx_available": "0",
  31.                    "jmx_errors_from": "0",
  32.                    "jmx_error": "",
  33.                    "name": "Template OS Linux",
  34.                    "flags": "0",
  35.                    "templateid": "10001",
  36.                    "description": "",
  37.                    "tls_connect": "1",
  38.                    "tls_accept": "1",
  39.                    "tls_issuer": "",
  40.                    "tls_subject": "",
  41.                    "tls_psk_identity": "",
  42.                    "tls_psk": ""
  43.                },
  44.                {
  45.                    "proxy_hostid": "0",
  46.                    "host": "Template OS Windows",
  47.                    "status": "3",
  48.                    "disable_until": "0",
  49.                    "error": "",
  50.                    "available": "0",
  51.                    "errors_from": "0",
  52.                    "lastaccess": "0",
  53.                    "ipmi_authtype": "0",
  54.                    "ipmi_privilege": "2",
  55.                    "ipmi_username": "",
  56.                    "ipmi_password": "",
  57.                    "ipmi_disable_until": "0",
  58.                    "ipmi_available": "0",
  59.                    "snmp_disable_until": "0",
  60.                    "snmp_available": "0",
  61.                    "maintenanceid": "0",
  62.                    "maintenance_status": "0",
  63.                    "maintenance_type": "0",
  64.                    "maintenance_from": "0",
  65.                    "ipmi_errors_from": "0",
  66.                    "snmp_errors_from": "0",
  67.                    "ipmi_error": "",
  68.                    "snmp_error": "",
  69.                    "jmx_disable_until": "0",
  70.                    "jmx_available": "0",
  71.                    "jmx_errors_from": "0",
  72.                    "jmx_error": "",
  73.                    "name": "Template OS Windows",
  74.                    "flags": "0",
  75.                    "templateid": "10081",
  76.                    "description": "",
  77.                    "tls_connect": "1",
  78.                    "tls_accept": "1",
  79.                    "tls_issuer": "",
  80.                    "tls_subject": "",
  81.                    "tls_psk_identity": "",
  82.                    "tls_psk": ""
  83.                }
  84.            ],
  85.            "id": 1
  86.        }

See also 参考

Source 源码

CTemplate::get() in frontends/php/include/classes/api/services/CTemplate.php. CTemplate::get()方法可在frontends/php/include/classes/api/services/CTemplate.php中参考。

Source

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