GetDashboardWidgetImage
- Print
- PDF
GetDashboardWidgetImage
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
Available in VPC
You can specify a dashboard and widgets and download their data in a PNG file. (image size: 800 * 600)
Requests
API URL
URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/chart/dashboard/{dashboardId}/widgets/{widgetId}?startTime={startTime}&endTime={endTime}
Method: GET
Request headers
Request headers specified in the common settings are needed.
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
Request parameters
| Parameter name | Parameter type | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|---|
| dashboardId | path | Y | String | ID of the dashboard where the widget you'd like to download is included | |
| widgetId | path | Y | String | ID of the widget you'd like to download | |
| startTime | query | Y | Long | The time the dashboard display started in milliseconds | |
| endTime | query | Y | Long | The time the dashboard display ended in milliseconds | |
| widgetResolutionMode | query | N | String | AUTO, HIGH, default: AUTO | Set query interval.AUTO Select this to set it to the same query interval as on the console dashboard and select HIGH to set it differently, that is, for more detailed data query, than on the console dashboard. |
Examples
Request examples
GET /cw_fea/real/cw/api/chart/dashboard/df_457958429047263232/widgets/avg_cpu_used_rto__457958429047263232?startTime=1650261600000&endTime=1650358800000
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
If query is completed without any errors, an HTTP code 200 is returned. If you have specified an output file with the PNG extension, a widget image with the same file name is downloaded.
Was this article helpful?