콘텐츠로 이동

통합 카탈로그 엔터티 수정¶

POST /api/v1/unified_catalog/entity/modify

개요¶

통합 카탈로그 엔터티를 수정합니다.

Body 요청 파라미터¶

파라미터명	유형	필수	설명
urn	string		엔터티 URN, 수정 대상을 정확히 지정하기 위해 전달하는 것을 권장합니다 비워 둘 수 없음: False
entityType	string	Y	엔터티 유형 코드 비워 둘 수 없음: False
name	string	Y	엔터티 이름 비워 둘 수 없음: False
attributes	json		엔터티 속성 객체 비워 둘 수 없음: False
telemetrySelectors	array		연결 쿼리 정보 구성 비워 둘 수 없음: False

파라미터 추가 설명¶

요청 파라미터 설명

파라미터명	type	필수	설명
urn	string	아니요	엔터티 URN, 엔터티를 정확히 지정하기 위해 전달하는 것을 권장합니다
entityType	string	예	엔터티 유형 코드
name	string	예	엔터티 이름
attributes	json	아니요	업데이트할 엔터티 속성 객체
telemetrySelectors	array	아니요	업데이트할 엔터티 연결 쿼리 구성

관계 필드 사용 설명

attributes.depends_on은 links로 기록됩니다.
attributes.component_of는 contains로 기록되며, 방향은 parent/system -> 현재 엔터티입니다.
attributes.components도 contains로 기록되며, 방향은 현재 엔터티 -> component입니다.
관계를 비우려면 빈 배열을 명시적으로 전달하세요. 예: {"component_of":[]} 또는 {"components":[]}.

호출 시 주의사항

urn, entityType, name을 함께 전달하는 것을 권장합니다.
수정 성공 시 대상 엔터티의 urn이 반환됩니다.
태그 필드에 새 태그 이름을 전달하면 해당 태그도 자동으로 생성됩니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urn":"urn:system:default:core","entityType":"system","name":"core","attributes":{"project":"demo","env":"test","components":[]}}'

응답¶

{
    "code": 200,
    "content": {
        "urn": "urn:mysql:default:demo"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}