보고서 서식 조회

식별자로 지정한 보고서 서식을 조회합니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/report-templates/e2fad16d-8076-4c91-9d69-9419c5e6d300

요청 매개변수

경로 매개변수

정상 응답

{
  "template": {
    "guid": "e2fad16d-8076-4c91-9d69-9419c5e6d300",
    "name": "보고서 서식",
    "description": "보고서 서식 설명",
    "group_guid": "eaf5e265-a186-4029-9264-dade868559ba",
    "group_name": "보고서 그룹",
    "owner_guid": "ce23adf2-13e4-40f9-ad0c-74d090b1f10c",
    "owner_name": "데모",
    "sections": [
      {
        "type": "paragraph",
        "title": "개요",
        "query": "json \"{}\" | eval line=concat($(\"from\"), \" ~ \", $(\"to\") , \" 동안 실행한 쿼리 현황입니다.\")",
        "visible": true,
        "ordinal": 0,
        "created": "2024-08-13 09:53:39+0900",
        "updated": "2024-08-13 09:53:39+0900"
      },
      {
        "type": "grid",
        "title": "시간 당 쿼리 건수",
        "query": "table from=$(\"from\") to=$(\"to\") araqne_query_logs | search isnotnull(duration) | timechart span=1h count",
        "visible": true,
        "ordinal": 1,
        "created": "2024-08-13 09:53:39+0900",
        "updated": "2024-08-13 09:53:39+0900"
      },
      {
        "type": "vbar",
        "title": "시간 당 쿼리 건수 차트",
        "options": {
          "log_scale": true,
          "percentage": false,
          "label": true
        },
        "query": "table from=$(\"from\") to=$(\"to\") araqne_query_logs | search isnotnull(duration) | timechart span=1h count",
        "visible": true,
        "ordinal": 2,
        "created": "2024-08-13 09:53:39+0900",
        "updated": "2024-08-13 09:53:39+0900"
      }
    ],
    "created": "2024-08-08 10:27:42+0900",
    "updated": "2024-08-13 09:53:39+0900"
  }
}

• template (맵): 보고서 서식 정보
  • guid (문자열): 보고서 서식 GUID
  • name (문자열): 보고서 서식 이름
  • description (문자열): 보고서 서식 설명
  • group_guid (문자열): 보고서 그룹 GUID
  • group_name (문자열): 보고서 그룹 이름
  • owner_guid (문자열): 소유자 GUID
  • owner_name (문자열): 소유자 성명
  • sections (배열): 서식 항목들
    • type (문자열): 서식 항목 유형. paragraph(단락), memo(메모), grid(표), hbar(가로 막대 차트), hbar_stck(누적 가로 막대 차트), vbar(세로 막대 차트), vbar_stck(누적 세로 막대 차트), line(라인 차트), area_stacked(누적 영역 차트), pie(파이 차트) 중 하나
    • title (문자열): 제목
    • options (맵, 선택): 항목 설정값 (type이 hbar, hbar_stck, vbar, vbar_stck, line, area_stacked, pie인 경우)
      • log_scale (불리언): 로그 스케일 적용 여부 (type이 hbar, hbar_stck, vbar, vbar_stck, line, area_stacked인 경우)
      • percentage (불리언): 백분율 적용 여부 (type이 hbar, hbar_stck, vbar, vbar_stck, line, area_stacked인 경우)
      • pie_donut (불리언): 파이 차트 도넛 적용 여부 (type이 pie인 경우)
      • label (불리언): 레이블 적용 여부 (type이 hbar, hbar_stck, vbar, vbar_stck, pie인 경우)
    • query (문자열): 항목 생성용 쿼리
    • visible (불리언): 항목 표시 여부
    • ordinal (32비트 정수): 항목 순서
    • created (문자열): 항목 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
    • updated (문자열): 항목 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • created (문자열): 서식 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • updated (문자열): 서식 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)

오류 응답

보고서 서식이 존재하지 않는 경우

HTTP 상태 코드 200 응답

{
  "template": null
}

guid가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

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

보고서 서식 조회 권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}