콘텐츠로 이동

통합 카탈로그 엔터티 삭제



POST /api/v1/unified_catalog/entity/delete

개요

엔터티를 하드 삭제합니다.

호출 전 및 사용 단계

인증된 워크스페이스를 기준으로 대상 엔터티와 연관 엣지를 삭제하며, 연관 엔터티는 재귀적으로 삭제하지 않습니다. 하드 삭제이므로 수명 주기 보호 표시의 제한을 받지 않으며, 다시 보고하면 재생성될 수 있습니다. 실행 전에 URN과 필요한 속성을 백업하고 비즈니스 필요성을 확인해야 하며, 이 인터페이스를 수명 주기 비활성화 용도로 사용해서는 안 됩니다.

감사를 위해 먼저 기존 엔터티를 읽은 다음 다운스트림 삭제를 동기적으로 요청합니다. 별도의 "실제 삭제된 행 수"는 반환하지 않으며, 성공 시에는 true만 반환합니다. 오류가 발생하면 먼저 다시 읽어 확인하고, 오류만으로 삭제되지 않았다고 단정해서는 안 됩니다. 단건 삭제를 일괄 삭제 결과 구조로 취급하지 마십시오.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
urn string 예 읽기/삭제 시 필수이며 앞뒤 공백을 제거한 후 비어 있지 않아야 합니다. 목록/통계에서는 선택적 정확 필터로 사용됩니다. 수정 시에는 원래 URN을 명확히 입력하여 이름 변경 시 다른 엔터티가 생성되지 않도록 하십시오.
null 허용: False
예: urn:database:default:demo
획득 또는 입력 방법: 이 공간의 엔터티 목록 items[].urn에서 가져오며, 가능하면 전체 URN을 그대로 사용합니다.

파라미터 추가 설명

요청 파라미터 설명

파라미터 이름 type 필수 설명
urn string 예 삭제할 엔터티의 URN

호출 시 유의 사항

  • 삭제 성공 시 true를 반환합니다.
  • 이 인터페이스는 Kodo 측의 해당 엔터티도 함께 삭제합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/unified_catalog/entity/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"urn":"urn:database:default:demo"}'

응답

HTTP 200, application/json. 아래 예시는 직접 확인할 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content boolean 삭제 호출 성공 시 true이며, 엔터티/삭제 수량은 반환하지 않습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

다운스트림 오류는 Kodo 공유 매핑을 따르며, 4xx는 실제 HTTP 상태 및 ft.KodoCommonApiErr 또는 매핑된 비즈니스 코드를 반환할 수 있습니다. 모든 실패가 406으로 변환되는 것은 아닙니다. 전달되지 않은 5xx/연결 예외/성공 결과 구조 불일치는 최종적으로 500 ft.InternalServerError가 됩니다. errorCode/message/traceId를 보존하고 읽기 또는 쓰기 단계에 따라 처리하십시오. 성공 HTTP 응답이 엔터티의 실제 가시성 검증을 대체할 수는 없습니다.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형, 값을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하십시오.
400 ft.JsonFormatError Body 최상위가 JSON 객체가 아님 일부 json 파일 형식 오류 예시대로 객체를 제출하고, 배열/문자열을 사용하지 마십시오.
406 ft.InvalidParameter urn이 비어 있음; 일괄 삭제 urns가 1..500개의 비어 있지 않고 공백 제거 후 중복되지 않는 문자열이 아님 파라미터 {} 유효하지 않음 현재 공간의 실제 URN 목록을 사용하고, 먼저 중복을 제거한 뒤 대상을 확인하십시오. 임의의 객체/숫자를 제출하지 마십시오.
500 ft.InternalServerError 다운스트림 삭제/기존 엔터티 읽기 실패, 시간 초과 또는 일괄 삭제 시 반환된 카운트/목록 불일치 내부 오류 삭제가 이미 커밋되었을 수 있으므로 먼저 대상의 현재 상태를 확인하십시오. 동일한 대상을 계속 삭제해야 하는 경우 제한적으로 재시도하고 traceId를 보존하십시오.

문서 평가

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