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 返回一个items属性，包含图形原型中使用的items和item prototypes。
selectTemplates query 返回一个templates属性，包含图形原型所属的模板。
filter object 仅返回与给定过滤器完全匹配的结果。

接受一个array，其中键是属性名称，值是要匹配的单个值或array的值。

支持额外的过滤器：
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) 返回以下两种情况之一:

  • 一个包含array的objects数组
  • 检索到的objects数量（当使用了countOutput参数时）

示例

从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 文件中.