대시보드 이미지 다운로드 토큰 생성

대시보드 위젯 또는 탭 화면을 이미지로 렌더링한 후, 파일 다운로드 API를 사용해 이미지 파일을 다운로드할 수 있습니다. 발급된 토큰은 1회만 사용 가능하며, 30분 후 만료됩니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

GET /api/sonar/dashboard-images/download

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/dashboard-images/download?type=widget&guid=9e3da276-ebcc-4798-a406-fc7712ddd322&width=800&height=600&download_type=png"

요청 매개변수

키	필수	타입	설명	비고
type	O	문자열	대상 유형	`widget` 또는 `tab`
guid	O	문자열	대상 GUID	위젯 또는 탭 화면의 GUID(36자)
width	X	32비트 정수	이미지 가로 픽셀	기본값: 800. 1 이상 4096 이하
height	X	32비트 정수	이미지 세로 픽셀	기본값: 600. 36 이상 4096 이하
download_type	X	문자열	다운로드 형식	`jpg`(기본값) 또는 `png`. 그 외 값은 `jpg`로 처리

Note

type이 widget인 경우 guid는 위젯 GUID를, tab인 경우 guid는 탭 화면 GUID를 지정합니다. 이미지 상단에는 높이 35px의 제목 영역이 고정으로 추가되므로 height는 35보다 커야 합니다.

정상 응답

HTTP 상태 코드 200 응답

{ "token": "4ba40c97-b31b-450f-8af8-ceb1b94f5514" }

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "guid should be not null"
}

guid가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

type 값이 widget 또는 tab이 아닌 경우

HTTP 상태 코드 500 응답

{
  "error_code": "invalid type: must be widget or tab",
  "error_msg": null
}

width 값이 0 이하인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "width must be positive"
}

height 값이 35 이하인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "height must be greater than 35"
}

width 또는 height 값이 4096을 초과하는 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "width and height must not exceed 4096px"
}

위젯을 찾을 수 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "widget not found",
  "error_msg": null
}

탭 화면을 찾을 수 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "tab not found",
  "error_msg": null
}