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

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

필요 권한

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

HTTP 요청

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"

요청 매개변수

지원하지 않는 위젯 유형을 요청하면 대체 이미지가 렌더링됩니다.

정상 응답

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
}

이미지 크기가 유효 범위를 벗어난 경우

HTTP 상태 코드 400 응답

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

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

위젯 또는 탭을 찾을 수 없는 경우

HTTP 상태 코드 500 응답

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