콘텐츠로 이동

내보내기



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

개요

지정된 내장 뷰를 JSON 템플릿으로 내보냅니다.

호출 전 및 사용 단계

내장 뷰 목록에서 활성 내장 뷰를 선택합니다. 응답의 content를 저장하고, 생성 시 이를 templateInfos에 전달할 수 있습니다. 내보내기 시 기본 쿼리 공간 및 대상 사이트 정보가 제거되므로 마이그레이션 후 다시 구성해야 합니다. 내보낸 템플릿에는 dashboardBidding이 포함되지 않으므로 내장 뷰 상세에서 바인딩을 별도로 저장하세요.

라우트 파라미터

파라미터명 타입 필수 설명
dashboard_uuid string Y 현재 워크스페이스의 내장 뷰 UUID입니다.
예: dsbd_inner_example
가져오기 또는 입력 방법: 내장 뷰 목록의 content.data[].uuid에서 가져오거나, 생성 응답의 content.uuid를 사용할 수도 있습니다.

요청 헤더

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

Query 요청 파라미터

파라미터명 타입 필수 설명
title string 템플릿 title을 재정의하며, 원본 뷰 이름은 변경하지 않습니다.
null 허용: False
예: 巡检模板
가져오기 또는 입력 방법: 내보내기 파일에 필요한 표시 제목을 입력하거나, 생략하여 뷰 이름을 그대로 사용할 수 있습니다.

파라미터 추가 설명

반환된 JSON 객체를 사용하여 차트, 레이아웃, 그룹 및 변수를 마이그레이션합니다. 서로 다른 워크스페이스의 외부 데이터 소스는 바인딩을 확인해야 합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/dashboard/dsbd_inner_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": "host-overview",
    "dashboardType": "CUSTOM",
    "dashboardExtend": {},
    "dashboardMapping": [],
    "dashboardBindSet": [],
    "iconSet": {},
    "main": {
      "type": "template",
      "charts": [],
      "vars": [],
      "groups": [],
      "chartGroupPos": []
    },
    "dashboardOwnerType": "inner",
    "tagInfo": [],
    "thumbnail": "",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인하세요.
404 ft.NotFoundView 대상이 존재하지 않거나, 삭제되었거나, 이 워크스페이스에 속하지 않음 지정된 뷰를 찾을 수 없음 동일한 워크스페이스의 내장 뷰 목록에서 여전히 유효한 UUID를 가져오세요.
403 ft.ForbiddenOperationResource API Key에 대상 뷰에 대한 유효한 작업 권한이 없음 현재 작업 권한 없음 워크스페이스 소유권과 API Key 권한을 확인하거나 리소스 생성자에게 문의하세요.
403 ft.ForbiddenAccessResourceNoPublic 프라이빗 뷰에 액세스하는 주체와 뷰 생성 주체가 다름 현재 리소스 액세스 권한이 없으며, 현재 페이지가 비공개 상태입니다 액세스 권한이 있는 생성 주체가 작업하도록 하고, 동일한 워크스페이스의 API Key를 사용하는지 확인하세요.
406 ft.InvalidParameter 기존 차트 쿼리 구조가 유효하지 않아 유효한 템플릿으로 내보낼 수 없음 파라미터 {}가 유효하지 않음 오류의 필드 경로에 따라 원본 뷰 차트 구성을 확인하고, 수정한 후 다시 내보내세요.

문서 평가

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