Documentation
Table of Contents
graphprototype.get
描述
integer/array graphprototype.get(object parameters)该方法允许根据给定的参数检索图形原型。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见 User roles。
参数
(object) 参数定义了期望的输出。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| discoveryids | ID/array | 仅返回属于给定发现规则的图形原型。 |
| graphids | ID/array | 仅返回具有给定ID的图形原型。 |
| groupids | ID/array | 仅返回属于给定主机或属于给定主机组或模板组中的模板的图形原型。 |
| hostids | ID/array | 仅返回属于给定主机的图形原型。 |
| inherited | boolean | 若设置为 true，则仅返回从模板继承的图形原型。 |
| itemids | ID/array | 仅返回包含给定监控项原型的图形原型。 |
| templated | boolean | 若设置为 true，则仅返回属于模板的图形原型。 |
| templateids | ID/array | 仅返回属于给定模板的图形原型。 |
| selectDiscoveryRule | query | 返回一个包含图形原型所属LLD规则的discoveryRule属性。 |
| selectGraphItems | query | 返回一个包含图形原型中使用的图形监控项的gitems属性。 |
| selectHostGroups | query | 返回一个包含图形原型所属主机组的hostgroups属性。 |
| selectHosts | query | 返回一个包含图形原型所属主机的hosts属性。 |
| selectItems | query | 返回一个包含图形原型中使用的items和item prototypes的items属性。 |
| selectTemplateGroups | query | 返回一个包含图形原型所属模板组的templategroups属性。 |
| selectTemplates | query | 返回一个包含图形原型所属模板的templates属性。 |
| filter | object | 仅返回与给定过滤器完全匹配的结果。 接受一个object，其中键是属性名称，值是单个值或一个array值数组用于匹配。 不支持 text 数据类型的属性。支持额外的属性： host - 图形原型所属主机的技术名称；hostid - 图形原型所属主机的ID。 |
| sortfield | string/array | 按照给定属性对结果进行排序。 可能的值： graphid、name、graphtype、discovered。 |
| countOutput | boolean | 这些参数在通用get方法参数中描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (deprecated) |
query | 此参数已弃用，请改用 selectHostGroups 或 selectTemplateGroups。返回一个包含图形原型所属主机组和模板组的 groups 属性。 |
返回值
(integer/array) 返回以下之一：
- array 的 objects；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
从LLD规则检索图形原型
从LLD规则中检索所有图形原型。
执行请求:
{
"jsonrpc": "2.0",
"method": "graphprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"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 中。