콘텐츠로 이동

통합 카탈로그 엔터티 상세 정보¶

POST /api/v1/unified_catalog/entity/get

개요¶

단일 통합 카탈로그 엔터티의 상세 정보를 조회합니다.

Body 요청 매개변수¶

매개변수명	타입	필수	설명
urn	string	Y	엔터티 URN 빈 값 허용: False 예시: urn:mysql:default:demo

매개변수 추가 설명¶

요청 매개변수 설명

매개변수명	type	필수	설명
urn	string	예	대상 엔터티의 고유 URN

반환 결과 설명

엔터티 기본 정보, attributes, teamInfo, tagsInfo를 반환합니다.
systemRelationInfo는 현재 엔터티의 1홉 직접 시스템 관계 목록입니다.
healthConfig/healthEnabled/healthScore/healthStatus/healthUpdateAt는 항상 반환됩니다. 모든 유형에 대해 항상 유효한 구성에 따라 반환되며, 백엔드 readiness 정리 진행 상황에 의존하지 않습니다.

호출 시 주의사항

systemRelationInfo는 재귀적으로 확장되지 않으며, 직접 관계만 반환합니다.
systemRelationInfo에서 관계 양쪽 엔터티 요약의 attributes는 전체 데이터가 반환됩니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:mysql:default:demo"}'

응답¶

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo",
        "entityType": "database",
        "name": "demo",
        "attributes": {
            "project": "demo",
            "env": "prod"
        },
        "healthConfig": {},
        "healthEnabled": false,
        "healthScore": null,
        "healthStatus": "unknown",
        "healthUpdateAt": null,
        "teamInfo": [],
        "tagsInfo": [],
        "systemRelationInfo": []
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}