graphprototype.get

描述

integer/array graphprototype.get(object parameters)

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

此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅User roles

参数

(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规则的lld规则属性。
selectGraphItems query 返回包含图形原型中使用的图形监控项的gitems属性。
selectGroups query 返回包含图形原型所属主机组的groups属性。
selectHosts query 返回包含图形原型所属主机的hosts属性。
selectItems query 返回包含图形原型中使用的itemsitem prototypesitems属性。
selectTemplates query 返回包含图形原型所属模板的templates属性。
filter object 仅返回完全匹配筛选条件的结果。

接受array,其中键为属性名,值为单个匹配值或值的array。

支持附加筛选条件:
host - 图形原型所属主机的技术名称;
hostid - 图形原型所属主机的ID。
sortfield string/array 按指定属性排序结果。

可选值为:graphidnamegraphtype
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) 返回以下两种结果之一:

  • 一个包含objects的array;
  • 若使用了countOutput参数,则返回检索到的objects数量。

示例

从LLD规则检索图形原型

从LLD规则中获取所有图形原型。

请求:

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

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "1017",
                   "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
       }

另请参阅

来源

CGraphPrototype::get() 方法位于 ui/include/classes/api/services/CGraphPrototype.php 文件中。