GetDashboardWidgetList

Overview

It is available in a VPC environment.

Specifies a dashboard and gets the list of widgets in it.

Request

API URL

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

Request header

The request headers specified in common settings are required.

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

Request parameter

Examples

Request examples

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}

Response examples

The API returns HTTP code 200 as well as the widget ID list for the specified dashboard in the JSON format, as long as the query is completed without any errors.

[
  { "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" }
]