GetDashboardWidgetImage
- 인쇄
- PDF
GetDashboardWidgetImage
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
개요
Dashboard와 Widget을 지정하여, 해당 Dashboard Widget의 Data를 PNG 파일 형태로 다운로드합니다.
요청
API URL
URL: https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/chart/dashboard/{dashboardId}/widgets/{widgetId}?startTime={startTime}&endTime={endTime}
Method: GET
요청 헤더
공통설정에 명시된 요청헤더가 필요합니다.
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
요청 파라미터
| 파라미터명 | 파라미터 종류 | 필수 여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|---|
| dashboardId | path | Y | String | 다운로드 하고자 하는 Widget이 포함된 Dashboard ID | |
| widgetId | path | Y | String | 다운로드 하고자 하는 Widget ID | |
| startTime | query | Y | Long | 대시보드 표기 시작시간 in milliseconds | |
| endTime | query | Y | Long | 대시보드 표기 종료시간 in milliseconds | |
| height | query | N | Integer | 다운로드 할 이미지 높이 | |
| width | query | N | Integer | 다운로드 할 이미지 넓이 | |
| timezone | query | N | String | UTC-11 ~ UTC+12 혹은 GMT-11 ~ GMT+12, default : UTC+9(GMT+9) | 다운로드 하고자 하는 Widget의 timezone |
| widgetResolutionMode | query | N | String | AUTO, HIGH, default: AUTO | 조회 간격(Interval) 설정 옵션.AUTO 일 경우 콘솔 대시보드와 동일한 조회 간격으로 조회하고, HIGH 일 경우 콘솔 대시보드와 다른 조회 간격으로 데이터를 더 자세히 조회 |
예시
요청 예시
GET /cw_fea/real/cw/api/chart/dashboard/df_457958429047263232/widgets/avg_cpu_used_rto__457958429047263232?startTime=1650261600000&endTime=1650358800000
Host: cw.apigw.gov-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이 반환되며, 확장자를 .png로 하는 output file을 지정하면 해당 file 이름으로 Widget 이미지가 다운로드됩니다.
이 문서가 도움이 되었습니까?