获取
描述
integer/array graphprototype.get(object parameters)
该方法允许根据指定的参数来检索图形原型。
这种方法对任何类型的用户都适用。调用该方法的权限可以在用户角色设置中被撤销。 前往用户角色以了解更多信息。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| discoveryids | ID/数组 | 仅返回属于给定发现规则的图表原型。 |
| graphids | ID/数组 | 仅返回具有给定ID的图表原型。 |
| groupids | ID/数组 | 仅返回属于给定主机组或模板组中的主机或模板的图表原型。 |
| hostids | ID/数组 | 仅返回属于给定主机的图表原型。 |
| inherited | 布尔值 | 如果设置为true，仅返回从模板继承的图表原型。 |
| itemids | ID/数组 | 仅返回包含给定项目原型的图表原型。 |
| templated | 布尔值 | 如果设置为true，仅返回属于模板的图表原型。 |
| templateids | ID/数组 | 仅返回属于给定模板的图表原型。 |
| selectDiscoveryRule | 查询 | 返回一个discoveryRule属性，其中包含图表原型所属的LLD规则。 |
| selectGraphItems | 查询 | 返回一个gitems属性，其中包含图表原型中使用的图表项。 |
| selectHostGroups | 查询 | 返回一个hostgroups属性，其中包含图表原型所属的主机组。 |
| selectHosts | 查询 | 返回一个hosts属性，其中包含图表原型所属的主机。 |
| selectItems | 查询 | 返回一个items属性，其中包含图表原型中使用的项目和项目原型。 |
| selectTemplateGroups | 查询 | 返回一个templategroups属性，其中包含图表原型所属的模板组。 |
| selectTemplates | 查询 | 返回一个templates属性，其中包含图表原型所属的模板。 |
| filter | 对象 | 仅返回与给定过滤器完全匹配的结果。 接受一个对象，其中键是属性名称，值是一个单一值或与之匹配的值数组。 不支持 text数据类型的属性。支持额外属性： host - 图表原型所属主机的技术名称；hostid - 图表原型所属主机的ID。 |
| sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值： graphid，name，graphtype，discovered。 |
| countOutput | 布尔值 | 这些参数在参考说明中描述。 |
| editable | 布尔值 | |
| excludeSearch | 布尔值 | |
| limit | 整数 | |
| output | 查询 | |
| preservekeys | 布尔值 | |
| search | 对象 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 | |
| selectGroups (已废弃) |
查询 | 此参数已废弃，请改用selectHostGroups或selectTemplateGroups。返回一个 groups属性，其中包含图表原型所属的主机组和模板组。 |
返回值
返回 (integer/array) 其中之一:
- 一个对象的数组;
- 如果使用了
countOutput参数，则为检索到的对象的数量。
示例
从LLD规则中检索图表原型
从LLD规则中检索所有图表原型。
请求:
{
"jsonrpc": "2.0",
"method": "graphprototype.get",
"params": {
"output": "extend",
"discoveryids": "27426"
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"graphid": "1017",
"name": "磁盘空间使用情况 {#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() in ui/include/classes/api/services/CGraphPrototype.php.