콘텐츠로 이동

가져오기



POST /api/v1/viewer/{viewer_uuid}/import

개요

기존 소스 뷰 또는 템플릿을 지정한 탐색기에 덮어씁니다.

호출 전 및 사용 단계

먼저 탐색기 내보내기를 호출하여 대상을 백업합니다. 가져오기 템플릿을 선택하거나 현재 워크스페이스에 존재가 확인된 소스 뷰를 참조합니다. sourceDashboardUUID를 제출하면 해당 소스 뷰에서 템플릿을 생성합니다. 빈 문자열이거나 이미 유효하지 않은 소스는 내보내기 결과가 비어 있을 수 있으며 그대로 대상 덮어쓰기를 계속하므로, 제출 전에 반드시 검증해야 합니다. 대상 UUID는 유지되며, 기존 차트, 그룹 및 변수는 먼저 삭제된 후 템플릿에 따라 생성됩니다. templateInfo={}이거나 main을 생략하면 이러한 기존 내용이 비워집니다. 예시는 빈 템플릿을 사용하므로, 실제 마이그레이션 시에는 완전한 템플릿을 전달하십시오. 템플릿은 먼저 검증되고, 삭제와 재생성은 동일 트랜잭션에서 완료됩니다. 오류가 발생하면 먼저 현재 내용과 백업을 확인한 후 복구를 결정합니다.

라우팅 파라미터

파라미터 이름 타입 필수 설명
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를 획득합니다.

Body 요청 파라미터

파라미터 이름 타입 필수 설명
ownerType string 가져오기 후 리소스 소유자이며 기본값은 viewer입니다.
null 허용: False
예시: viewer
획득 또는 입력 방법: 탐색기 용도를 유지하는 경우 생략하거나 viewer를 입력합니다.
sourceDashboardUUID string 이 필드를 제공하면 서버가 소스 뷰에서 템플릿을 우선 내보냅니다.
null 허용: False
예시: dsbd_source_example
획득 또는 입력 방법: 탐색기 목록 또는 대시보드 목록에서 내보내기가 가능한 것으로 확인된 실제 소스 UUID를 가져옵니다. templateInfo를 사용할 때는 이 필드를 생략합니다.
templateInfo json 소스 뷰 방식과 택일입니다. 템플릿 객체에는 완전한 main이 포함되어야 합니다.
null 허용: False
예시: {"title": "主机巡检查看器", "summary": "主机巡检与状态核对", "identifier": "", "dashboardType": "CUSTOM", "dashboardExtend": {}, "dashboardMapping": [], "dashboardBindSet": [], "iconSet": {}, "main": {"type": "template", "charts": [], "vars": [], "groups": [], "chartGroupPos": []}}
획득 또는 입력 방법: 먼저 탐색기 내보내기를 호출하여 content 객체를 획득합니다. 그대로 사용하거나 조정이 필요한 템플릿 필드를 수정합니다.

파라미터 추가 설명

가져오기에는 단수 templateInfo를 사용합니다. 대시보드 템플릿 필드 설명에서 템플릿 필드를 설명합니다. 비어 있지 않은 title, summary, identifier 등은 기존 속성을 재정의할 수 있습니다. dashboardExtend, dashboardMapping, dashboardType을 생략하면 각각 빈 객체, 빈 배열, CUSTOM으로 처리됩니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/import' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"templateInfo":{"title":"主机巡检查看器","summary":"主机巡检与状态核对","identifier":"","dashboardType":"CUSTOM","dashboardExtend":{},"dashboardMapping":[],"dashboardBindSet":[],"iconSet":{},"main":{"type":"template","charts":[],"vars":[],"groups":[],"chartGroupPos":[]}}}'

응답

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

필드 타입 설명
content.id integer 탐색기 레코드 번호입니다.
content.uuid string 탐색기 UUID입니다.
content.workspaceUUID string 소속 워크스페이스입니다.
content.name string 탐색기 이름입니다.
content.desc string 탐색기 설명입니다.
content.identifier string 사용자 정의 식별자이며 비어 있을 수 있습니다.
content.ownerType string 탐색기 리소스 소유자이며 일반적으로 viewer입니다.
content.type string 탐색기 유형이며 예: CUSTOM입니다.
content.isPublic integer 현재 리소스의 공개 범위입니다. 1은 공개, 0은 생성자에게만 표시됩니다.
content.chartPos array<object> 차트 레이아웃 배열이며 chartUUID와 레이아웃 객체 pos를 포함합니다.
content.chartPos[].chartUUID string 참조된 차트 UUID입니다.
content.chartPos[].pos object 레이아웃의 위치 및 크기이며 예: x, y, w, h입니다.
content.chartGroupPos array<string> 차트 그룹 정렬 순서입니다.
content.iconSet object 아이콘 설정입니다.
content.extend object 탐색기 확장 정보입니다.
content.mapping array<object> 변수 필드 매핑 정보입니다.
content.dashboardBindSet array 뷰 바인딩 설정입니다.
content.createdWay string 리소스 생성 출처입니다.
content.openPermissionSet boolean 엔터티 레코드의 권한 설정 스위치입니다.
content.permissionSet array<string> 레코드의 작업 권한 주체 UUID입니다.
content.readPermissionSet array<string> 레코드의 읽기 권한 주체 UUID입니다.
content.tagInfo array<object> 연관된 태그 정보입니다.
content.tagInfo[].id string 태그 UUID와 동일한 식별자입니다.
content.tagInfo[].uuid string 태그 UUID입니다.
content.tagInfo[].name string 태그 이름입니다.
content.tagInfo[].description string 태그 설명입니다.
content.tagInfo[].colour string 태그 색상입니다.
content.tagInfo[].scope array<string> 태그 적용 범위입니다.
content.tagInfo[].tagPermissionInfo object 존재할 경우 읽기/쓰기 권한 부여 정보입니다.
content.status integer 레코드 상태입니다.
content.creator string 생성자 신원 ID입니다.
content.updator string 최근 수정자 신원 ID이며 비어 있을 수 있습니다.
content.createAt number 생성 시간이며 Unix 초입니다.
content.updateAt number 수정 시간이며 Unix 초입니다. 수정되지 않은 경우 -1일 수 있습니다.
content.deleteAt number 삭제 시간이며 Unix 초입니다. 삭제되지 않은 경우 -1입니다.
content.creatorInfo object 생성자 신원 정보이며, 조회되지 않으면 빈 객체입니다.
content.updatorInfo object 최근 수정자 신원 정보이며, 조회되지 않으면 빈 객체입니다.
content.creatorInfo.uuid string 해당 신원이 조회된 경우 제공될 수 있습니다. 신원 식별자입니다.
content.creatorInfo.status integer 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 상태입니다.
content.creatorInfo.wsAccountStatus integer 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 멤버 상태입니다.
content.creatorInfo.username string 해당 신원이 조회된 경우 제공될 수 있습니다. 로그인 이름입니다.
content.creatorInfo.name string 해당 신원이 조회된 경우 제공될 수 있습니다. 표시 이름입니다.
content.creatorInfo.iconUrl string 해당 신원이 조회된 경우 제공될 수 있습니다. 아바타 URL입니다.
content.creatorInfo.email string 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 이메일입니다. API Key 신원은 그 식별자를 반환할 수 있습니다.
content.creatorInfo.mobile string 해당 신원이 조회된 경우 제공될 수 있습니다. 연락처입니다.
content.creatorInfo.countryCode string 해당 신원이 조회된 경우 제공될 수 있습니다. 휴대폰 국가 또는 지역 코드입니다.
content.creatorInfo.acntWsNickname string 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 내 닉네임입니다.
content.updatorInfo.uuid string 해당 신원이 조회된 경우 제공될 수 있습니다. 신원 식별자입니다.
content.updatorInfo.status integer 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 상태입니다.
content.updatorInfo.wsAccountStatus integer 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 멤버 상태입니다.
content.updatorInfo.username string 해당 신원이 조회된 경우 제공될 수 있습니다. 로그인 이름입니다.
content.updatorInfo.name string 해당 신원이 조회된 경우 제공될 수 있습니다. 표시 이름입니다.
content.updatorInfo.iconUrl string 해당 신원이 조회된 경우 제공될 수 있습니다. 아바타 URL입니다.
content.updatorInfo.email string 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 이메일입니다. API Key 신원은 그 식별자를 반환할 수 있습니다.
content.updatorInfo.mobile string 해당 신원이 조회된 경우 제공될 수 있습니다. 연락처입니다.
content.updatorInfo.countryCode string 해당 신원이 조회된 경우 제공될 수 있습니다. 휴대폰 국가 또는 지역 코드입니다.
content.updatorInfo.acntWsNickname string 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 내 닉네임입니다.
content.skippedTags array<object> 범위가 일치하지 않아 건너뛴 태그입니다.
content.skippedTags[].name string 건너뛴 이름입니다.
content.skippedTags[].scope array<string> 기존 태그 범위입니다.
content.skippedTags[].expectedScope string 기대한 태그 범위입니다.
content.skippedTags[].reason string 건너뛴 이유입니다.
content.skippedTags[].resourceUUID string 존재할 경우 연관된 리소스 UUID입니다.
content.declaration object 또는 null 워크스페이스의 공용 선언입니다.
{
  "code": 200,
  "content": {
    "id": 25,
    "uuid": "dsbd_view_example",
    "name": "主机巡检查看器",
    "desc": "主机巡检与状态核对",
    "workspaceUUID": "wksp_example",
    "identifier": "",
    "ownerType": "viewer",
    "type": "CUSTOM",
    "isPublic": 1,
    "chartPos": [],
    "chartGroupPos": [],
    "iconSet": {},
    "extend": {},
    "mapping": [],
    "dashboardBindSet": [],
    "createdWay": "import",
    "openPermissionSet": false,
    "permissionSet": [],
    "readPermissionSet": [],
    "tagInfo": [],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "creatorInfo": {},
    "updatorInfo": {},
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 필드 타입 또는 값이 선언과 일치하지 않거나 선언되지 않은 최상위 필드가 포함됨 파라미터 파싱 실패 파라미터 위치, 필드 이름, 타입 및 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
400 ft.JsonFormatError JSON 구문은 유효하지만 요청 최상위가 객체가 아님 일부 json 파일 형식 오류 파라미터를 JSON 객체로 전달합니다.
404 ft.NotFoundView 대상이 없거나 삭제되었거나 현재 워크스페이스에 없음 지정한 뷰를 찾을 수 없음 동일 워크스페이스의 탐색기 목록에서 유효한 UUID를 다시 확인합니다.
403 ft.ForbiddenFreeEditionLimit 워크스페이스에 수량 제한이 설정되어 한도에 도달함 무료 플랜 워크스페이스 {}가 한도({} 개)에 도달하여 새로 생성할 수 없습니다. 상용 플랜을 개통하면 제한이 해제됩니다 현재 버전과 탐색기 수량을 확인합니다.
406 ft.ExceedMaxCharacterLimit 템플릿의 차트 또는 그룹 이름이 256자를 초과하거나 태그 이름이 128자를 초과함 {}이(가) 최대 문자 길이 제한을 초과했습니다 필드 길이 제한에 맞게 템플릿을 수정합니다.
400 ft.IdentificationIdExists 템플릿 식별자가 대상 타입에서 다른 뷰에 의해 이미 사용 중임 식별ID가 이미 존재합니다 템플릿 식별자를 변경한 후 다시 시도합니다.
406 ft.MissingImportTemplateResourceUUID 소스 UUID가 제출되지 않았고 템플릿도 없음 가져오기 템플릿/가져오기 소스 뷰 UUID가 누락되었습니다 확인 가능한 실제 소스 UUID 또는 내보낸 템플릿 객체를 전달합니다.
406 ft.InvalidParameter 템플릿 구조가 유효하지 않음. 예: main이 객체가 아님, charts, vars 또는 groups가 배열이 아님, 또는 차트 쿼리 구조가 유효하지 않음 파라미터 {}가 유효하지 않습니다 오류에서 지적된 필드 경로에 따라 템플릿을 수정합니다. 이 버전의 내보내기 API가 반환한 완전한 템플릿을 우선 사용하십시오.

문서 평가

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