콘텐츠로 이동

스냅샷/차트 공유 취소



GET /api/v1/share_config/delete

개요

GET 요청을 통해 지정된 공유 구성 및 최초 진입 자격 증명을 철회합니다.

호출 전 및 사용 단계

현재 Key에는 share.shareManage 권한이 필요합니다. GET이지만 이 인터페이스는 상태를 변경하고 액세스를 철회하므로 프리페치/주기적 상태 프로브용으로 사용해서는 안 됩니다. shareConfigUUIDs는 현재 콘솔의 공유 관리 목록에서 현재 워크스페이스의 share_ UUID를 가져옵니다. 스냅샷 snap_, token/authCode 또는 공유 URL이 아닙니다. 여러 UUID는 쉼표로 구분하며 각 항목은 trim하지 않습니다.

이 공유 삭제 경로는 resourceType=snapshot으로 제한되지 않으며 동일 워크스페이스의 다른 차트/대시보드 공유도 삭제할 수 있으므로, 호출자는 먼저 resourceType과 resourceUUID를 확인해야 합니다. 현재 워크스페이스에서 삭제되지 않은 일치 구성만 소프트 삭제하며, 알 수 없거나 다른 워크스페이스에 속하거나 이미 삭제된 항목은 무시합니다. 일반적으로 true를 반환하며 항목별 결과는 없습니다.

먼저 공유 삭제를 제출한 다음 장기 최초 진입 code와 캐시를 철회하고 2단계 share token 캐시를 정리합니다. 실패 시 공유가 이미 비활성화되었거나 일부 캐시 정리가 아직 끝나지 않았을 수 있으므로, 먼저 콘솔에서 공유 상태를 확인하고 실제 접속으로 검수하십시오. 500을 철회 롤백으로 간주하지 마십시오. 원본 스냅샷, 대시보드, 텔레메트리는 삭제되지 않습니다. 다시 공유하면 새로운 구성과 code가 생성되며 이전 URL 복원은 보장되지 않습니다.

요청 헤더

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

Query 요청 매개변수

매개변수명 유형 필수 설명
shareConfigUUIDs commaArray Y 필수이며 비어 있지 않은 쉼표로 구분된 문자열로, JSON 배열이 아닙니다. 먼저 각 공유 유형을 확인하여 다른 리소스 공유를 잘못 철회하지 않도록 하십시오. 앞뒤 공백은 항목별로 정리하지 않습니다.
빈 문자열 허용: False
null 허용: False
예: share_example
획득 또는 입력 방법: 현재 콘솔의 공유 관리 목록에서 공유 구성 uuid(share_)를 가져오고 resourceType=snapshot과 대상 resourceUUID를 확인합니다. 이 OpenAPI 그룹에는 ShareConfig 목록이 없으므로, UI에 UUID가 표시되지 않으면 워크스페이스 관리자에게 획득을 요청해야 하며 다른 워크스페이스의 권한 부여 구성 grant_ UUID를 사용할 수 없습니다.

매개변수 추가 설명

스냅샷은 페이지 구성과 서버 측 쿼리 범위를 저장합니다. 인터넷 공유는 별도로 공유 구성을 생성해야 하며, snap_, share_, 최초 진입 code 및 2단계 token은 서로 다른 식별자입니다.

요청 예시

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

응답

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

필드 유형 설명
content boolean 성공 시 true이며, 일치 항목이 없어도 일반적으로 true입니다. declaration/항목별 결과는 포함하지 않습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방식
406 ft.ParameterValidationFailed 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반함 매개변수 파싱 실패 Query 매개변수 표와 예시를 확인하십시오.
500 ft.InternalServerError 공유 소프트 삭제, 후속 최초 진입 code 철회/2단계 token 캐시 정리 또는 감사 자료 인덱스에서 처리되지 않은 예외 발생 내부 오류 먼저 콘솔에서 공유 구성 상태를 확인하고 기존 링크가 더 이상 유효하지 않은지 검증하십시오. 대상이 이미 삭제되었을 수 있습니다. traceId를 보존하여 자격 증명 캐시 대조를 완료하고 공유를 중복 생성하지 마십시오.

문서 평가

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