콘텐츠로 이동

삭제



POST /api/v1/data_query_rule/delete

개요

액세스 규칙을 일괄 소프트 삭제합니다.

호출 전 및 사용 단계

먼저 UUID와 영향을 받는 ID를 확인한 후 일괄 제출합니다. 규칙만 소프트 삭제하며 원본 데이터는 삭제하지 않으며, 역할의 기본 조회 권한을 취소하는 것과 같지 않습니다. 삭제 후에는 이 모듈의 get 읽기로 더 이상 읽을 수 없고, 활성화 API로 복구할 수 없습니다. true만 반환하며 항목별 결과를 제공하지 않으므로 일부 UUID가 유효하지 않아도 404를 반환하지 않습니다. 빈 배열이거나 모두 일치하지 않는 경우에도 성공 true를 반환할 수 있으며, 이는 실제 일치 수를 의미하지 않습니다.

쓰기는 구성을 대체하고 데이터베이스에 커밋한 뒤 규칙 캐시를 지우고 감사를 기록합니다. 교차 사이트 검증은 리소스 정보를 읽거나 업데이트할 수도 있습니다. 이 단계는 단일 원자적 트랜잭션이 아니므로 500/시간 초과 후에는 목록/상세에서 저장 여부를 먼저 확인하여 무작정 반복 생성하는 것을 피해야 합니다.

규칙 저장은 이후 조건에 맞는 ID의 데이터 조회 범위/결과 마스킹에 영향을 주며, 원본 데이터를 수정, 삭제 또는 추가 수집하지 않고 역할의 기본 조회 권한도 추가하지 않습니다. 여러 역할 및 규칙은 조회 측 정책에 따라 병합되며, 단일 규칙만으로 최종 권한을 추론할 수 없습니다. Owner는 예외이며, 관리자 및 워크스페이스의 “데이터 액세스 범위 제한” 설정은 일치하는 역할이 없을 때의 처리를 변경하므로 대표 구성원으로 실제 조회하여 검증해야 합니다. 저장 후에는 규칙 캐시가 무효화되지만 진행 중인 모든 조회가 즉시 전환된다고 보장할 수는 없습니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
queryRuleUuids[*] string 단일 비어 있지 않은 UUID이며, 원래 선언에서는 항목별 검증을 수행하지 않았습니다.
예: lqrl_example
획득 또는 입력 방법: 단일 규칙 uuid.
queryRuleUuids array Y 필수 배열이며 비어 있지 않은 것을 권장합니다. 현재 워크스페이스에서 삭제되지 않은 일치 항목만 대상으로 하며, 로그 모듈은 logging으로도 제한됩니다.
null 허용: False
예: ["lqrl_example"]
획득 또는 입력 방법: 데이터 액세스 규칙 목록에서 대상 UUID 집합을 가져옵니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/data_query_rule/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"queryRuleUuids":["lqrl_example"]}'

응답

HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content boolean 성공 시 true이며, 항목별 결과가 아니고 모든 입력 UUID가 변경되었음을 의미하지 않습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고합니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
500 ft.InternalServerError 배열 항목 형태가 맞지 않음, 필드가 저장 길이를 초과함, 다운스트림 일반 5xx, 데이터베이스 또는 커밋 후 캐시 실패 내부 오류 본문 구조와 길이를 확인하고 현재 구성을 읽어 데이터베이스에 저장되었는지 확인한 후 재시도 여부를 결정하며 traceId를 제공합니다.

문서 평가

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