콘텐츠로 이동

통합 카탈로그 토폴로지 엔터티 필드 정의¶

GET /api/v1/unified_catalog/topology/entity_fields

개요¶

통합 카탈로그 토폴로지에서 사용 가능한 필드 정의를 조회합니다.

Query 요청 파라미터¶

파라미터명	유형	필수	설명
entityType	string		엔터티 유형 코드; 비어 있거나 전달하지 않으면 모든 엔터티 유형의 필드를 반환 비어 있어도 됨: True

파라미터 보충 설명¶

요청 파라미터 설명

파라미터명	type	필수	설명
entityType	string	아니요	엔터티 유형 코드

호출 시 주의사항

entityType을 전달하지 않거나 빈 문자열을 전달하면 현재 워크스페이스의 모든 엔터티 유형 필드를 반환합니다.
특정 엔터티 유형의 필드 정의만 필요한 경우, 해당 entityType을 전달하여 반환 범위를 축소하는 것이 좋습니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/topology/entity_fields?entityType=service' \
-H 'DF-API-KEY: <DF-API-KEY>'

응답¶

{
    "code": 200,
    "content": {
        "items": [
            {
                "field": "project",
                "title": "프로젝트",
                "entityTypes": [
                    "service",
                    "database"
                ]
            },
            {
                "field": "env",
                "title": "환경",
                "entityTypes": [
                    "service"
                ]
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}