콘텐츠로 이동

내보내기



GET /api/v1/dashboards/{dashboard_uuid}/export

개요

지정된 대시보드를 이식 가능한 템플릿 객체로 내보냅니다.

호출 전 및 사용 단계

읽기에 성공한 후 응답의 content를 저장하면 생성 또는 가져오기의 templateInfo로 사용할 수 있습니다. 로컬에서 대상 대시보드를 확인해야 할 경우 먼저 목록 또는 상세 정보로 UUID를 검증합니다. 내보내기 시 원래 워크스페이스의 기본 쿼리 공간 및 사이트 설정이 제거되므로, 마이그레이션 후 대상 워크스페이스에서 다시 설정해야 합니다.

경로 파라미터

파라미터 이름 유형 필수 설명
dashboard_uuid string Y 대상 대시보드 UUID입니다.
예: dsbd_example
확인 또는 입력 방법: 대시보드 목록의 content.data[].uuid에서 복사하거나 생성 결과의 content.uuid를 사용할 수 있습니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
확인 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터 이름 유형 필수 설명
title string 선택 사항입니다. 내보내는 템플릿의 제목만 변경하며, 생략하면 원본 제목을 유지합니다.
예: 프로덕션 점검 템플릿
확인 또는 입력 방법: 필요에 따라 내보내기 템플릿에 저장할 제목을 입력합니다.

파라미터 추가 설명

이 API는 JSON 객체를 반환하며, content를 전달되는 템플릿 본문으로 사용합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/export' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.title string 템플릿 이름입니다. title Query 파라미터를 제공하면 해당 값을 사용합니다.
content.summary string 템플릿 설명입니다.
content.identifier string 대시보드의 사용자 지정 식별자입니다.
content.dashboardType string 대시보드 유형입니다.
content.dashboardOwnerType string 원본 대시보드의 소유 유형입니다.
content.dashboardExtend object 이식 가능한 확장 정보입니다. 기본 쿼리 공간과 대상 사이트는 가져오기 후 다시 구성해야 합니다.
content.dashboardMapping array<object> 필드 매핑 목록입니다.
content.dashboardBindSet array 연결된 바인딩 설정입니다.
content.iconSet object 대시보드 아이콘 정보입니다.
content.thumbnail string 썸네일 필드입니다.
content.tagInfo array<object> 템플릿에 연결된 태그입니다.
content.main object 템플릿의 차트, 변수 및 차트 그룹입니다.
content.main.type string 내보내기 템플릿의 경우 template으로 고정됩니다.
content.main.charts array<object> 템플릿 차트 정의입니다.
content.main.vars array<object> 뷰 변수 정의입니다.
content.main.groups array<object> 차트 그룹 정의입니다.
content.main.groups[].name string 차트 그룹 이름입니다.
content.main.groups[].extend object 차트 그룹의 확장 설정입니다.
content.main.chartGroupPos array<string> 차트 그룹의 정렬 기록입니다.
content.declaration object 또는 null 워크스페이스의 공용 선언입니다.
{
  "code": 200,
  "content": {
    "title": "生产巡检",
    "summary": "生产服务巡检指标",
    "identifier": "prod-check",
    "dashboardType": "CUSTOM",
    "dashboardExtend": {},
    "dashboardMapping": [],
    "iconSet": {},
    "dashboardBindSet": [],
    "main": {
      "type": "template",
      "charts": [],
      "vars": [],
      "chartGroupPos": [],
      "groups": []
    },
    "dashboardOwnerType": "node",
    "thumbnail": "",
    "tagInfo": [],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

현재 워크스페이스 내에서 활성 대시보드를 찾을 수 없으면 HTTP 200과 빈 객체를 반환할 수 있습니다. 비어 있지 않은 title을 함께 제공하면 결과에 내보내기 제목과 공통 응답 필드만 포함될 수 있습니다. 템플릿을 사용하기 전에 main 포함 여부를 먼저 확인하세요.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.InvalidParameter 기존 차트 조회 구조가 유효하지 않아 유효한 템플릿으로 내보낼 수 없습니다. 파라미터 {}이(가) 유효하지 않습니다. 오류의 필드 경로를 기준으로 원본 뷰의 차트 구성을 확인하고, 수정한 후 다시 내보내세요.

문서 평가

이 페이지가 도움이 되었나요?