콘텐츠로 이동

삭제



GET /api/v1/wksp_share/delete

개요

권한 부여 구성 UUID를 기준으로 현재 워크스페이스에서 발급한 권한 부여를 일괄 소프트 삭제합니다.

호출 전 준비 및 사용 단계

생성/수정/삭제에는 데이터 권한 부여자 워크스페이스의 API Key를 사용하며, 조회는 현재 Key 워크스페이스의 권한 부여 방향에 따라 동작합니다. 이 API 그룹이 부여하는 것은 워크스페이스 간 데이터 조회 권한이며, 구성원 초대나 계정 역할 부여, 데이터 복사를 의미하지 않습니다. 응답의 workspaceUUID는 권한 부여자, toWorkspaceUUID는 권한 부여 대상자입니다. 생성 시 Body.workspaceUUID만이 권한 부여 대상 워크스페이스를 의미하며, 응답의 동일한 이름 필드와 방향이 다릅니다. 조회가 실제로 유효한지는 데이터 도메인, 로그 인덱스, 필터 조건, 실제 권한 부여 상태 및 소스 워크스페이스 상태에 의해서도 제한됩니다.

생성/수정/삭제에는 dataRightsManage.workspaceConfigManage 권한이 필요합니다. 먼저 권한 부여 목록에서 type=grant로 현재 워크스페이스가 발급한 레코드를 조회하여 content.data[].uuid를 가져오세요. 권한 부여 대상 목록에 있는 다른 소스 워크스페이스의 UUID를 자신이 수정할 수 있는 구성으로 간주하지 마세요. 결과를 알 수 없을 때는 먼저 구성을 다시 읽어 중복 권한 부여나, 실패했지만 전혀 실행되지 않았다고 오인하는 상황을 피하세요.

이 엔드포인트는 삭제 부작용이 있는 레거시 GET 엔드포인트이므로 읽기 전용 조회, 프리페치 또는 활성 확인 용도로 사용할 수 없습니다. deleteUUIDs에는 권한 부여 구성 UUID를 영문 쉼표로 연결하여 입력하며, 권한 부여 대상 워크스페이스 UUID가 아닙니다. 현재 워크스페이스가 발급한 일치 레코드만 소프트 삭제하며, 알 수 없거나 다른 소스 워크스페이스에 속하거나 이미 삭제되었거나 빈 집합인 경우 아무 작업 없이 true로 성공할 수 있으므로, true로 삭제 건수를 집계할 수 없습니다.

각 구성은 개별적으로 커밋됩니다. 사이트 간 레코드는 revoked로 표시되고 로컬 사이트 접근 캐시를 정리하며, 이전 원격에 삭제를 능동적으로 요청하지 않습니다. 원격 목록에 잔여 표시가 있다고 해서 소스 권한 부여가 여전히 유효한 것은 아닙니다. 이 엔드포인트는 참조하는 모든 모니터를 능동적으로 비활성화하지 않으며 원본 데이터도 삭제하지 않습니다. 삭제 배치의 후속 캐시/사이트 알림 준비가 실패하면 앞선 항목은 이미 삭제되었을 수 있습니다. 오류가 발생하면 권한 부여 목록을 다시 읽어 남은 항목을 확인한 후 재시도 여부를 결정하세요. 알림 내부 오류는 기록만 될 수 있으며 전달이 보장되지 않습니다.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 타입 필수 설명
deleteUUIDs commaArray Y 필수 쉼표 구분 문자열이며 각 항목의 앞뒤 공백은 제거됩니다. 알 수 없거나 일치하지 않는 경우 아무 작업 없이 성공할 수 있습니다. 워크스페이스 UUID, 대문자 키 DeleteUUIDs 또는 JSON 배열은 전달할 수 없습니다.
null 허용: False
예: grant_example
획득 또는 입력 방법: type=grant인 권한 부여 목록의 content.data[].uuid에서 항목별로 가져옵니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/wksp_share/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode deleteUUIDs=grant_example

응답

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

필드 타입 설명
content boolean 라우팅 성공 시 항상 true이며 영향받은 수량은 없습니다. 모든 입력이 존재하거나 모든 연관이 정리되었음을 의미하지는 않습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

현재 소스 워크스페이스의 status=0 모델 레코드만 일치하며, 권한 부여 양측 워크스페이스가 모두 활성 상태임을 보장하지 않습니다. 일치 항목이 없어도 항상 404가 반환되지는 않으며, 배치는 전부 성공 또는 전부 실패하는 트랜잭션이 아닙니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방식
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표와 예시를 확인하세요.
500 ft.InternalServerError 스토리지, 항목별 커밋 후 캐시 무효화 또는 사이트 알림 준비 이상 내부 오류 먼저 type=grant 목록을 읽어 어떤 항목이 삭제되었는지 확인한 후 남은 대상에 대해 재시도하세요. traceId를 보존하세요.

문서 평가

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