GetDashboardWidgetList

概要

VPC環境で利用できます。

Dashboardを指定し、そのDashboardでWidgetリストを照会します。

リクエスト

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/chart/dashboard/{dashboardId}/widgets
Method: GET

リクエストヘッダ

共通の設定に明示されたリクエストヘッダが必要です。

x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

リクエストパラメータ

例

リクエスト例

GET /cw_fea/real/cw/api/chart/dashboard/df_457958429047263232/widgets
Host: cw.apigw.ntruss.com
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

レスポンス例

エラーなく照会が完了した場合、HTTP code 200と指定したDashboardのWidget ID ListがJSON形式で照会されます。

[
  { "dashboardId": "df_457958429047263232", "name": "memory usage", "widgetId": "mem_usert__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "average cpu usage", "widgetId": "avg_cpu_used_rto__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "average file system usage", "widgetId": "avg_fs_usert__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "network send average", "widgetId": "avg_snd_bps__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "network receive average", "widgetId": "avg_rcv_bps__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "gpu count", "widgetId": "gpu_count__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "gpu memory usage ratio", "widgetId": "vmem_usage__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "gpu memory usage MiB", "widgetId": "vmem_usage_mib__457958429047263232" },
  { "dashboardId": "df_457958429047263232", "name": "gpu usage", "widgetId": "usage__457958429047263232" }
]