콘텐츠로 이동

내보내기



POST /api/v1/tag/export

개요

현재 워크스페이스 태그의 마이그레이션 가능한 구성 배열을 내보냅니다.

호출 전 및 사용 단계

POST는 URL Query를 통해 필터링합니다. Query가 비어 있지 않으면 JSON Body를 사용하지 않습니다. 필터가 없으면 ?search=에 빈 문자열을 명시하거나, Content-Type: application/json과 함께 {}를 전달할 수 있습니다. 그렇지 않으면 라우트가 비 JSON 요청 본문을 읽을 때 415가 발생하고 일괄적으로 500이 반환될 수 있습니다. 통합 JSON의 content 배열을 반환하며, 파일 다운로드가 아닙니다. 현재 워크스페이스에서 status=0인 태그만 내보내며, id 내림차순으로 정렬하고 name/description/colour/scope를 유지합니다. UUID, 참조, 리소스 권한 또는 시간은 내보내지 않습니다. 일치 항목이 없으면 성공 시 []입니다.

요청 헤더

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

Query 요청 파라미터

파라미터명 타입 필수 설명
filter string 선택 사항이며, 해당 유형에서 현재 참조 중인 태그만 조회합니다. 참조가 없으면 빈 값을 반환합니다. search와 AND로 조합됩니다. 전달하지 않으면 모든 유효 태그를 조회하며, 일반 이름 태그 및 콜론 이름 태그를 포함합니다. 내보내기에서는 SecurityRuleRefTagObject 보안 규칙을 추가로 허용합니다.
null 허용: False
선택 가능한 값: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'SmartCheckerRefTagObject', 'AiCheckerRefTagObject', 'DialingRefTagObject', 'SecurityRuleRefTagObject']
예: BoardRefTagObject
획득 또는 입력 방법: 리소스 연결 유형 선택: BoardRefTagObject 대시보드, ViewerRefTagObject 탐색기, CheckerRefTagObject 일반 모니터링, SmartCheckerRefTagObject 지능형 모니터링, AiCheckerRefTagObject AI 모니터링, DialingRefTagObject 신서틱 테스트.
search string 선택 사항이며, name에 포함 일치로 검색하고 앞뒤 공백을 제거합니다. %/_는 SQL LIKE 의미를 그대로 따르며, 설명은 검색하지 않습니다.
null 허용: False
예: production
획득 또는 입력 방법: 대상 태그 이름 키워드.

파라미터 추가 설명

이 인터페이스는 전역 태그를 별도로 내보내는 데 사용되며, 워크스페이스 리소스 내보내기 작업을 거칠 필요가 없습니다.

요청 설명

  1. 내보내기 파라미터는 태그 목록 인터페이스와 동일하게 유지되지만, 페이징 파라미터는 지원하지 않습니다.
  2. 현재 지원되는 필터 파라미터는 search, filter입니다.
  3. 현재 워크스페이스에서 유효한 태그만 내보냅니다.
  4. 반환 내용은 JSON 목록이며, /tag/import의 가져오기 템플릿으로 바로 사용할 수 있습니다.

내보내기 필드

필드 타입 설명
name string 태그 이름
description string 태그 설명
colour string 태그 색상

내보내지 않는 필드

  • uuid
  • workspaceUUID
  • creator
  • updator
  • createAt
  • updateAt

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/tag/export?search=production' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 타입 설명
content array<object> 템플릿 배열이며, 일치 항목이 없으면 []입니다.
content[].name string 태그 이름.
content[].description string 용도 설명.
content[].colour string 색상 표현.
content[].scope array<string> 정규화된 범위이며, 기존 null/빈 scope는 ["all"]로 반환됩니다.
content[].scope[] string all/scene/monitor/dialing/security/infrastructure/catalog 중 하나입니다.
content[].declaration object 배열 객체에 부가되는 공통 선언이며, 가져오기 전에 템플릿에서 삭제합니다.
{
  "code": 200,
  "content": [
    {
      "name": "production",
      "description": "生产资源统一标记。",
      "colour": "default",
      "scope": [
        "scene",
        "monitor"
      ],
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반한 경우 파라미터 파싱 실패 Query 파라미터 표와 예시를 확인하세요.
500 ft.InternalServerError 태그, 참조/권한 또는 신원 정보 읽기 및 응답 포맷팅 실패 내부 오류 워크스페이스와 조회 조건을 확인하고 잠시 후 다시 시도하세요. 계속 실패하면 traceId를 제공하세요.

문서 평가

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