콘텐츠로 이동

조회



GET /api/v1/tag/{tag_uuid}/get

개요

지정한 태그의 저장된 전체 엔터티와 범위를 읽습니다.

호출 전 및 사용 단계

현재 워크스페이스의 삭제되지 않은 태그를 반환하며, 엔터티 상태와 시간을 포함하고 목록의 tagPermissionInfo 또는 ID 요약은 포함하지 않습니다. 누락/교차 워크스페이스/삭제된 경우 ObjectNotExists를 반환합니다. scope의 과거 null 값은 ["all"]로 정규화되며, 새 요청에서 null을 전달할 수 있음을 의미하지 않습니다.

경로 파라미터

파라미터 이름 유형 필수 설명
tag_uuid string Y 현재 워크스페이스의 태그 UUID이며, 태그 이름, 목록의 숫자 페이지 번호 또는 리소스 UUID가 아닙니다.
예: tag_example
조회 또는 입력 방법: 태그 목록의 content.data[].uuid에서 가져옵니다.

요청 헤더

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

파라미터 추가 설명

데이터 설명

  • 응답 파라미터 설명
파라미터 이름 type 설명
name string 태그 이름
description string 필드 설명 정보
color string 프런트엔드와 백엔드에서 약속한 색상 유형, default,style_key1,style_key2 ~~
  • 색상 color 필드의 유형별 색상 참조:
    {
        "default": {"background": "#CCE6FF", "color": "rgba(0,0,0,0.8)"},
        "style_key1": {"background": "#3333FE", "color": "#FFFFFF"},
        "style_key2": {"background": "#428BCA", "color": "#FFFFFF"},
        "style_key3": {"background": "#364450", "color": "#FFFFFF"},
        "style_key4": {"background": "#E0E1FF", "color": "rgba(0,0,0,0.8)"},
        "style_key5": {"background": "#9400D3", "color": "#FFFFFF"},
        "style_key6": {"background": "#EDDBFF", "color": "rgba(0,0,0,0.8)"},
        "style_key7": {"background": "#CC328B", "color": "#FFF"},
        "style_key8": {"background": "#FCDEF0", "color": "rgba(0,0,0,0.8)"},
        "style_key9": {"background": "#DC143D", "color": "#FFFFFF"},
        "style_key10": {"background": "#FCBABA", "color": "rgba(0,0,0,0.8)"},
        "style_key11": {"background": "#BD0B48", "color": "#FFFFFF"},
        "style_key12": {"background": "#FDECD2", "color": "rgba(0,0,0,0.8)"},
        "style_key13": {"background": "#FFC29C", "color": "rgba(0,0,0,0.8)"},
        "style_key14": {"background": "#ED9120", "color": "#FFFFFF"},
        "style_key15": {"background": "#CD5B44", "color": "#FFFFFF"},
        "style_key16": {"background": "#FAF570", "color": "rgba(0,0,0,0.8)"},
        "style_key17": {"background": "#C29953", "color": "#FFFFFF"},
        "style_key18": {"background": "#02B140", "color": "#FFFFFF"},
        "style_key19": {"background": "#D5F4D5", "color": "rgba(0,0,0,0.8)"},
        "style_key20": {"background": "#009966", "color": "#FFFFFF"},
        "style_key21": {"background": "#023220", "color": "#FFFFFF"},
        "style_key22": {"background": "#E7E7E7", "color": "rgba(0,0,0,0.8)"},
        "style_key23": {"background": "#808080", "color": "#FFFFFF"}
    }
    

요청 예시

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

응답

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

필드 유형 설명
content.id integer 엔터티 레코드 번호이며, 목록 id는 UUID 문자열입니다(목록 필드 참조).
content.uuid string tag_태그 UUID.
content.workspaceUUID string 소속 워크스페이스.
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.status integer 0은 유효, 3은 삭제이며, 기타 과거 상태는 실제 데이터를 기준으로 합니다.
content.creator string 생성 주체.
content.updator string 최근 수정 주체.
content.createAt integer 생성 Unix 초.
content.updateAt integer 업데이트 Unix 초, 업데이트되지 않은 경우 -1.
content.deleteAt integer 삭제 Unix 초, 삭제되지 않은 경우 -1.
content.declaration object 공통 선언.
{
  "code": 200,
  "content": {
    "id": 100,
    "uuid": "tag_example",
    "workspaceUUID": "wksp_example",
    "name": "production",
    "description": "프로덕션 리소스를 일괄 태그 지정합니다.",
    "colour": "default",
    "scope": [
      "scene",
      "monitor"
    ],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
404 ft.ObjectNotExists 현재 워크스페이스에 해당하는 유효한 태그가 없거나 삭제되었습니다. 지정한 객체가 존재하지 않습니다. 현재 워크스페이스 목록에서 유효한 UUID를 가져옵니다.
500 ft.InternalServerError 태그, 참조/권한 또는 ID 정보 읽기 및 응답 포맷팅에 실패했습니다. 내부 오류 워크스페이스와 쿼리 조건을 확인하고 잠시 후 다시 시도하세요. 계속 실패하면 traceId를 제공하세요.

문서 평가

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