내보내기¶
GET /api/v1/viewer/{viewer_uuid}/export
개요¶
지정된 탐색기를 JSON 템플릿으로 내보냅니다.
호출 전 및 사용 단계¶
탐색기 목록에서 UUID를 가져옵니다. 응답의 content를 저장하여 탐색기 생성 또는 가져오기에 사용합니다. 내보내기 시 기본 쿼리 공간과 대상 사이트 설정이 제거됩니다. 외부 데이터 소스 이름 또는 식별자는 대상 공간에 맞게 다시 바인딩해야 할 수 있습니다. 템플릿 콘텐츠는 차트, 변수 및 그룹 구조를 유지합니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| viewer_uuid | string | Y | 현재 워크스페이스의 대상 탐색기 UUID. 예: dsbd_view_example가져오기 또는 입력 방법: 탐색기 목록의 content.data[].uuid에서 가져오거나 생성 응답의 content.uuid를 사용할 수 있습니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| title | string | 선택 사항이며 내보내기 제목을 덮어씁니다. 예: 호스트 점검 템플릿가져오기 또는 입력 방법: 내보내기 템플릿에만 사용할 제목을 입력합니다. |
파라미터 추가 설명¶
성공 응답의 content는 이식 가능한 템플릿 데이터입니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/viewer/dsbd_view_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.tagInfo[].name | string | 템플릿 태그 이름. |
| content.main | object | 템플릿 내 차트, 변수 및 그룹. |
| content.main.type | string | template로 고정됩니다. |
| content.main.vars | array<object> |
변수 정의 배열. |
| content.main.vars[].name | string | 변수 이름. |
| content.main.vars[].type | string | 변수 유형. |
| content.main.vars[].definition | object | 변수 정의이며 내용은 유형에 따라 달라집니다. |
| content.main.vars[].seq | integer | 변수 순서. |
| content.main.vars[].code | string | 변수 코드이며 변수 참조에 사용됩니다. |
| content.main.vars[].datasource | string | 변수의 데이터 소스. |
| content.main.vars[].valueSort | string | 변수 값 정렬 방식. |
| content.main.vars[].hide | integer | 변수 숨김 설정. |
| content.main.vars[].isHiddenAsterisk | integer | 별표 숨김 옵션 설정. |
| content.main.vars[].multiple | boolean | 다중 선택 허용 여부. |
| content.main.vars[].includeStar | boolean | 별표 옵션 포함 여부. |
| content.main.vars[].extend | object | 변수 확장 설정. |
| content.main.charts | array<object> |
차트 정의 배열입니다. 가져오기 시 차트 UUID가 다시 생성됩니다. |
| content.main.charts[].uuid | string | 원본 차트 UUID. |
| content.main.charts[].name | string | 차트 이름. |
| content.main.charts[].type | string | 차트 유형. |
| content.main.charts[].chartGroupUUID | string | 원본 차트 그룹 UUID. |
| content.main.charts[].group.name | string 또는 null | 차트 그룹 이름. |
| content.main.charts[].prevGroupName | string 또는 null | 이전 차트 그룹 이름. |
| content.main.charts[].pos | object | 레이아웃에서 차트의 위치와 크기. |
| content.main.charts[].queries | array<object> |
차트 쿼리 설정. |
| content.main.charts[].extend | 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": "",
"dashboardType": "CUSTOM",
"dashboardExtend": {},
"dashboardMapping": [],
"dashboardBindSet": [],
"iconSet": {},
"main": {
"type": "template",
"charts": [],
"vars": [],
"groups": [],
"chartGroupPos": []
},
"dashboardOwnerType": "viewer",
"thumbnail": "",
"tagInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
대상이 존재하지 않을 때 빈 객체가 성공적으로 반환될 수 있으며, title을 제공한 경우에도 템플릿 제목과 공통 필드만 반환될 수 있습니다. 먼저 main 반환 여부를 확인한 후 저장 및 가져오기를 수행하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.InvalidParameter | 기존 차트 쿼리 구조가 유효하지 않아 유효한 템플릿으로 내보낼 수 없습니다 | 파라미터 {}가 유효하지 않습니다 |
오류의 필드 경로에 따라 원본 뷰 차트 설정을 확인하고 수정한 후 다시 내보내세요. |