콘텐츠로 이동

통합 카탈로그 엔터티 유형 삭제



POST /api/v1/unified_catalog/entity_type_cfg/delete

개요

현재 워크스페이스에 엔터티가 없는 사용자 정의 유형을 삭제합니다.

호출 전 및 사용 단계

사용자 정의 유형만 삭제할 수 있으며, 공식 유형은 현재 워크스페이스 재정의를 구성할 수 있더라도 삭제할 수 없습니다. 삭제 전에 해당 유형의 현재 워크스페이스 엔터티 수를 동시에 조회하며, 수량이 >0이면 거부합니다. 유형 삭제는 소프트 삭제 설정이며, 이 API에서 엔터티를 일괄 삭제하지 않고, 다른 워크스페이스 유형 삭제/과거 재정의 기록 자동 정리를 보장하지 않습니다. 이후 수집에서 해당 유형이 계속 보고되지 않는지 먼저 확인합니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
entityTypeUUID string Y 상세 정보와 entityType 중 하나 이상이어야 하며, UUID가 비어 있지 않으면 우선하고 두 값의 일치 여부는 검증하지 않습니다. default는 숨겨진 status=3 생성 템플릿을 반환하며 엔터티 수를 조회하지 않습니다. 삭제 시 실제 유형 UUID를 필수로 입력하며 인코딩은 사용하지 않습니다.
null 허용: False
예시: enty_example
가져오기 또는 입력 방법: 유형 목록 items[].uuid에서 enty_ 식별자를 가져오거나 default로 생성 템플릿을 가져옵니다.

파라미터 추가 설명

요청 파라미터 설명

파라미터 이름 type 필수 설명
entityTypeUUID string 예 대상 엔터티 유형 UUID

호출 시 주의 사항

  • 사용자 정의 유형만 삭제할 수 있으며 기본 유형은 삭제를 지원하지 않습니다.
  • 해당 엔터티 유형 아래에 엔터티가 여전히 존재하면 API는 삭제 실패를 반환합니다.

요청 예시

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

응답

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 파일 형식 오류 예시에 따라 객체를 제출하고 배열/문자열은 사용하지 않습니다.
404 ft.NotFoundCatalogEntityType 대상 유형이 존재하지 않거나 이미 삭제되었거나 현재 표시되지 않음 지정된 엔터티 유형을 찾을 수 없습니다. 유형 목록에서 실제 대상 UUID를 가져옵니다.
406 ft.ForbiddenDeletePresetCatalogEntityType 대상 sourceType=default 시스템 사전 설정 엔터티 유형은 삭제를 지원하지 않습니다. 공식 유형을 유지하고 필요에 따라 워크스페이스 재정의 설정을 수정할 수 있습니다.
406 ft.CatalogEntityTypeHasEntities 해당 유형이 현재 워크스페이스에 여전히 엔터티가 있음 삭제 실패, 엔터티 유형 아래에 여전히 {}개의 엔터티가 있습니다. 먼저 엔터티 목록을 조회해 확인하고 비즈니스 권한에 따라 처리한 후, 수량이 0이 된 뒤 유형을 삭제합니다.
500 ft.InternalServerError 엔터티 수 확인, 유형 소프트 삭제/데이터베이스 커밋 또는 응답 처리 실패 내부 오류 먼저 유형 및 엔터티 현재 상태를 읽고 삭제 여부를 확인한 후 처리합니다. 이 삭제 작업은 헬스 구성 세대/재설정 작업을 실행하지 않습니다.

문서 평가

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