graph.get

説明

integer/array graph.get(object parameters)

このメソッドは、指定したパラメーターに応じたグラフを取得できます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメータ

(object) 必要な出力を定義するパラメータ。

このメソッドは以下のパラメータをサポートしています。

Parameter Type Description
graphids ID/array 指定したIDのグラフのみを返します。
groupids ID/array 指定したホストグループまたはテンプレートグループ内のホストまたはテンプレートに属するグラフのみを返します。
templateids ID/array 指定したテンプレートに属するグラフのみを返します。
hostids ID/array 指定したホストに属するグラフのみを返します。
itemids ID/array 指定したアイテムを含むグラフのみを返します。
templated boolean true に設定した場合、テンプレートに属するグラフのみを返します。
inherited boolean true に設定した場合、テンプレートから継承されたグラフのみを返します。
expandName flag グラフ名内のマクロを展開します。
selectDiscoveryData query グラフのディスカバリオブジェクトデータを含む discoveryData プロパティを返します。グラフのディスカバリオブジェクトは、ディスカバリされたグラフを、その元となったグラフプロトタイプに関連付けます。

以下のプロパティがあります。
parent_graphid - (ID) グラフの作成元となったグラフプロトタイプのID。
status - (int) グラフのディスカバリステータス:
0 - (default) グラフはディスカバリされています。
1 - グラフはすでにディスカバリされていません。
ts_delete - (timestamp) すでにディスカバリされなくなったグラフが削除される時刻。
selectDiscoveryRule query グラフを作成したローレベルディスカバリルールを含む discoveryRule プロパティを返します。
selectHostGroups query グラフが属するホストグループを含む hostgroups プロパティを返します。
selectTemplateGroups query グラフが属するテンプレートグループを含む templategroups プロパティを返します。
selectTemplates query グラフが属するテンプレートを含む templates プロパティを返します。
selectHosts query グラフが属するホストを含む hosts プロパティを返します。
selectItems query グラフで使用されるアイテムを含む items プロパティを返します。
selectGraphItems query グラフで使用されるアイテムを含む gitems プロパティを返します。
filter object 指定したフィルターに完全に一致する結果のみを返します。

キーがプロパティ名、値が一致対象となる単一の値または値の配列であるオブジェクトを受け付けます。

text data type のプロパティはサポートしていません。

追加のプロパティをサポートしています。
host - グラフが属するホストの技術名。
hostid - グラフが属するホストのID。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: graphid, name, graphtype。
countOutput boolean これらのパラメータは reference commentary で説明されています。
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGraphDiscovery query グラフのディスカバリオブジェクトを含む graphDiscovery プロパティを返します。グラフのディスカバリオブジェクトは、グラフをその作成元となったグラフプロトタイプに関連付けます。

このクエリは 非推奨 です。代わりに selectDiscoveryData を使用してください。

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメーターが使用されている場合、取得したオブジェクトの数

例

ホストからグラフの取得

ホスト"10107"から全てのグラフを取得し、名前でソートします。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "graph.get",
    "params": {
        "output": "extend",
        "hostids": 10107,
        "sortfield": "name"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "612",
            "name": "CPU jumps",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "613",
            "name": "CPU load",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "graphtype": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "614",
            "name": "CPU utilization",
            "width": "900",
            "height": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "1",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "0"
        },
        {
            "graphid": "645",
            "name": "Disk space usage /",
            "width": "600",
            "height": "340",
            "yaxismin": "0",
            "yaxismax": "0",
            "templateid": "0",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "flags": "4"
        }
    ],
    "id": 1
}

関連項目

ソース

CGraph::get() in ui/include/classes/api/services/CGraph.php.