Documentation
Table of Contents
graphitem.get
描述
integer/array graphitem.get(object parameters)
该方法允许根据给定的参数检索图形监控项。
此方法可供任何类型的用户使用。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见User roles。
参数
(object) 定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 说明 |
|---|---|---|
| graphids | ID/array | 仅返回属于指定图表的图表 监控项。 |
| itemids | ID/array | 仅返回具有指定 监控项 ID 的图表 监控项。 |
| type | integer | 仅返回具有指定类型的图表 监控项。 有关支持的图表 监控项 类型列表，请参阅 图表-监控项。 |
| selectGraphs | query | 返回一个 graphs 属性，其中包含该 监控项 所属图表的 array。 |
| sortfield | string/array | 按照指定属性对结果进行排序。 可能的值： gitemid。 |
| countOutput | boolean | 这些参数在 通用get方法参数 中有详细描述。 |
| editable | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| sortorder | string/array |
返回值
(integer/array) 返回以下之一：
- array 的 objects；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
从图表中检索图表 监控项
检索在图中使用的全部图形 监控项，并包含有关 监控项 和 主机 的附加信息。
执行请求:
{
"jsonrpc": "2.0",
"method": "graphitem.get",
"params": {
"output": "extend",
"graphids": "387"
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"gitemid": "1242",
"graphid": "387",
"itemid": "22665",
"drawtype": "1",
"sortorder": "1",
"color": "FF5555",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0"
},
{
"gitemid": "1243",
"graphid": "387",
"itemid": "22668",
"drawtype": "1",
"sortorder": "2",
"color": "55FF55",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0"
},
{
"gitemid": "1244",
"graphid": "387",
"itemid": "22671",
"drawtype": "1",
"sortorder": "3",
"color": "009999",
"yaxisside": "0",
"calc_fnc": "2",
"type": "0"
}
],
"id": 1
}另请参阅
来源
CGraphItem::get() 在 ui/include/classes/api/services/CGraphItem.php 中。