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