查询图表原型

查询图表原型

描述

integer/array graphprototype.get(object parameters)

该方法允许根据给定的参数来检索图表原型。

这个方法只适用于任何用户类型。调用该方法的权限可以在用户角色设置中被撤销。前往用户角色以了解更多信息。

参数

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

该方法支持下列参数。

参数	类型	描述
discoveryids	string/array	只返回属于给定发现规则的图表原型。
graphids	string/array	只返回具有给定ID的图表原型。
groupids	string/array	只返回属于给定主机组中的主机的图表原型。
hostids	string/array	只返回属于给定主机的图表原型。
inherited	boolean	如果设置为`true`，只返回从模板继承的图表原型。
itemids	string/array	只返回包含给定监控项原型的图表原型。
templated	boolean	如果设置为`true`，只返回属于模板的图表原型。
templateids	string/array	只返回属于给定模板的图表原型。
selectDiscoveryRule	query	返回一个发现规则属性，其带有图表原型所属的LLD规则。
selectGraphItems	query	返回一个图表项属性，其中包含图表原型中使用的图表项目。
selectGroups	query	返回一个主机组属性，包含图表原型所属的主机组。
selectHosts	query	返回一个主机属性，包含图表原型所属的主机。
selectItems	query	返回一个`items`属性，包含图表原型中使用的监控项和监控项原型。
selectTemplates	query	返回一个模板属性，其带有含图表原型所属的模板。
filter	object	只返回那些与给定过滤器完全匹配的结果。接受一个数组，其中键是属性名称，而值是匹配的一个单一的值或一个数组的值。支持额外的过滤器: `host` - 图表原型所属的主机的技术名称。 `hostid` - 图表原型所属的主机的ID。
sortfield	string/array	按给定的属性对结果进行排序。可能的取值： `graphid`、 `name` 和 `graphtype`。
countOutput	boolean	这些参数是所有 `get` 方法的共同参数，在参考注释中有详细描述。
editable	boolean
excludeSearch	boolean
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

返回值

返回 (integer/array) 其中之一：

一个对象的数组；
如果使用了countOutput参数，则为检索到的对象的数量。

示例

从 LLD 规则中检索图表原型

从一个 LLD 规则中检索所有的图表原型。

请求：

{
           "jsonrpc": "2.0",
           "method": "graphprototype.get",
           "params": {
               "output": "extend",
               "discoveryids": "27426"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应：

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "1017",
                   "parent_itemid": "27426",
                   "name": "Disk space usage {#FSNAME}",
                   "width": "600",
                   "height": "340",
                   "yaxismin": "0.0000",
                   "yaxismax": "0.0000",
                   "templateid": "442",
                   "show_work_period": "0",
                   "show_triggers": "0",
                   "graphtype": "2",
                   "show_legend": "1",
                   "show_3d": "1",
                   "percent_left": "0.0000",
                   "percent_right": "0.0000",
                   "ymin_type": "0",
                   "ymax_type": "0",
                   "ymin_itemid": "0",
                   "ymax_itemid": "0",
                   "discover": "0"
               }
           ],
           "id": 1
       }

另见

来源

ui/include/classes/api/services/CGraphPrototype.php 的 CGraphPrototype::get()。