콘텐츠로 이동

삭제



POST /api/v1/snapshots/{snapshot_uuid}/delete

개요

지정된 페이지 스냅샷을 소프트 삭제합니다.

호출 전 및 사용 단계

현재 Key에는 snapshot.delete 권한이 필요합니다. UUID는 현재 Key에서 조회 가능한 스냅샷 목록에서 가져와 관리 권한을 확인해야 합니다. 현재 삭제 백엔드는 UUID를 기준으로 대상을 찾으며 워크스페이스/생성자 필터를 안정적으로 적용하지 않습니다. 호출자는 자신이 권한을 부여받았고 현재 워크스페이스에 속함을 확인한 대상만 제출해야 하며, 잘못 선택한 UUID를 서버가 대신 거부해 주기를 기대해서는 안 됩니다. 알 수 없거나 이미 삭제된 경우에도 true를 반환하며, 일치 수는 제공하지 않습니다.

이 공개 엔드포인트는 deleteShareCfg를 전달하지 않으며, 공유 설정 취소/첫 홉 코드 철회/공유 캐시 정리를 함께 수행하지 않습니다. 스냅샷 소프트 삭제 후 관련 리소스 읽기가 무효화되지만, 공유 설정은 여전히 존재할 수 있습니다. 공유를 중지하려면 먼저 콘솔의 공유 관리에서 share_ UUID를 가져와 항목별로 취소해야 하며, snap_을 공유 취소에 전달해서는 안 됩니다. 원본 텔레메트리, 원본 대시보드 또는 애플리케이션은 삭제하지 않습니다. 공개 복구 API가 없으므로 구성을 미리 보관하세요.

경로 매개변수

매개변수 이름 유형 필수 설명
snapshot_uuid string Y 공유 설정 share_ UUID, token/authCode 첫 홉 코드 또는 대시보드 UUID가 아닙니다.
예: snap_example
가져오기 또는 입력 방법: 스냅샷 목록에서 content.data[].uuid를 가져오며, 현재 Key에 관리 권한이 확인된 snap_ UUID만 조작합니다.

요청 헤더

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

매개변수 추가 설명

스냅샷은 페이지 구성과 서버 조회 범위를 저장합니다. 인터넷 공유는 공유 설정을 별도로 생성해야 하며, snap_, share_, 첫 홉 code와 2단계 token은 서로 다른 식별자입니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/snapshots/snap_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content boolean 성공 시 true이며, 일치 항목이 없는 경우도 포함합니다. declaration/일치 수는 포함하지 않습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방식
500 ft.InternalServerError 스냅샷 소프트 삭제 또는 트랜잭션 커밋 중 처리되지 않은 예외 발생 내부 오류 먼저 스냅샷 목록에서 삭제 여부를 확인하세요. 실패를 미적용으로 간주하지 말고 traceId를 보관하세요. 관련 공유는 별도로 확인/취소해야 합니다.

문서 평가

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