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 属性。 |
selectDiscoveryRulePrototype | query | 返回一个discoveryRulePrototype 属性,其中包含该图形原型所属的父级LLD规则原型。 |
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 |
(integer/array)
返回以下两种结果之一:
countOutput
参数时)从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 文件中.