콘텐츠로 이동

일괄 삭제



POST /api/v1/workspace/inner_accesskey/batch_delete

개요

워크스페이스 UUID를 기준으로 활성 inner sys 시스템 Key를 일괄 삭제합니다.

호출 전 준비 및 사용 단계

w 권한이 필요합니다. 먼저 워크스페이스 목록으로 각 워크스페이스를 확인한 다음, 내장 Key 목록에서 해당 inner sys Key와 의존 대상을 확인합니다. 요청의 workspaceUUIDs는 반드시 워크스페이스 UUID 배열이어야 하며, Key 레코드 UUID도 아니고 평문 AK/SK도 아닙니다. 일치하는 워크스페이스에서 isSystem=1, businessType=inner sys, status=0인 Key만 소프트 삭제하며, 일반 API Key와 다른 시스템 비즈니스 Key는 이 작업의 영향을 받지 않습니다. 알 수 없는 워크스페이스, 활성 내장 Key가 없는 경우 또는 빈 배열인 경우에도 true를 반환할 수 있으며, 워크스페이스별 매칭 수량은 제공하지 않습니다. 현재 구현은 이전 AK의 인증 캐시를 능동적으로 무효화하지만, 이전 SK 캐시를 동시에 능동적으로 삭제하지는 않습니다. 이전 SK에 유효한 인증 캐시가 이미 존재하는 경우, 성공 응답만으로 모든 이전 자격 증명이 즉시 폐기되었다고 판단할 수 없으며, 관리자가 캐시 처리와 실제 인증 결과를 확인해야 합니다. 삭제 후 내장 Key 초기화 및 조회를 호출하면 Key가 다시 초기화되므로, 이를 사용해 “여전히 존재하지 않음”을 검증할 수 없습니다. 삭제 검증은 목록 조회와 실제 자격 증명 인증으로 수행하십시오.

요청 헤더

파라미터명 타입 필수 설명
X-Df-SVersion string 원본 경로 및 요청 본문 서명 버전입니다. 이를 생략하고 이 페이지의 알고리즘을 계속 사용할 수 없습니다.
예시: v20240417
획득 또는 입력 방법: 이 페이지의 예시는 이 고정 버전을 사용하며, 예시 서명 알고리즘과 함께 동작합니다.
X-Df-Access-Key string Y 이 모듈의 목록은 r 또는 w 권한으로 사용할 수 있으며, 나머지 세 항목과 GET 초기화는 모두 w 권한이 필요합니다.
예시: <external-access-key>
획득 또는 입력 방법: 사이트 관리자가 할당한 External API AK를 사용하며, 워크스페이스 OpenAPI Key는 사용할 수 없습니다.
X-Df-Nonce string Y 임시 일련번호입니다. 실패 후 재전송 시에도 새 값을 생성하고 서명을 다시 계산합니다.
예시: 97d275ee9f774315a7885ba7347acbd9
획득 또는 입력 방법: 매 요청마다 uuid.uuid4().hex를 다시 생성합니다.
X-Df-Signature string Y 대문자 메서드, nonce, 원본 전체 경로, timestamp, 원본 UTF-8 요청 본문을 공백으로 연결한 뒤 HMAC-SHA256을 수행하고 hex 다이제스트를 사용합니다.
예시: <hmac-sha256-hex>
획득 또는 입력 방법: External API 서명 인증에 따라 함께 제공된 SK로 계산하며, 전체 실행 가능한 템플릿은 아래와 같습니다.
X-Df-Timestamp string Y 사이트에 설정된 서명 유효 시간 범위 내여야 하며, 예시 시간을 재사용할 수 없습니다.
예시: 1785427200
획득 또는 입력 방법: 전송 시 str(int(time.time()))으로 현재 Unix 초 문자열을 생성합니다.

Body 요청 파라미터

파라미터명 타입 필수 설명
workspaceUUIDs[*] string 단일 워크스페이스 UUID이며, wsak_ 레코드 UUID가 아닙니다.
예시: wksp_example001
획득 또는 입력 방법: 워크스페이스 목록에서 단일 워크스페이스 uuid를 가져옵니다.
workspaceUUIDs array Y 필수 문자열 배열로, 워크스페이스 UUID 기준으로 삭제합니다. null은 허용되지 않으며, []는 어떤 Key도 삭제하지 않습니다.
null 허용: False
예시: ["wksp_example001"]
획득 또는 입력 방법: 워크스페이스 목록의 content.data[].uuid에서 처리할 워크스페이스를 하나씩 가져오며, 먼저 해당 내장 Key를 확인합니다.

파라미터 추가 설명

사이트 수준 External API 자격 증명을 사용하며, 인증은 External API 서명 인증을 참조하십시오. 목록은 r 또는 w 권한을 허용하며, 나머지 세 항목과 GET 초기화는 w 권한이 필요합니다. 모든 응답이 고권한 자격 증명 평문을 반환할 수 있으므로, 일반 프런트엔드 페이지의 마스킹 표시 규칙을 적용해서는 안 됩니다. 예시는 자리 표시자 값을 사용하며, 실제 자격 증명은 안전하게 보관해야 합니다. 데이터베이스 삭제 상태와 후속 캐시 처리는 단계적으로 수행되므로, 오류 발생 시 먼저 삭제된 범위를 확인하여 초기화/삭제를 반복하며 자격 증명을 전환하는 것을 피하십시오.

요청 예시

import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen

# 대상 사이트 주소 및 관리자가 할당한 External API AK/SK로 교체합니다.
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/workspace/inner_accesskey/batch_delete'
query = {}
data = {'workspaceUUIDs': ['wksp_example001']}
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
    "X-Df-Access-Key": access_key,
    "X-Df-Timestamp": timestamp,
    "X-Df-Nonce": nonce,
    "X-Df-Signature": signature,
    "X-Df-SVersion": "v20240417",
}
if data is not None:
    headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
    print(result.read().decode("utf-8"))

응답

HTTP 200, application/json 통합 래퍼를 사용하며 비즈니스 결과는 content에 위치합니다. External은 declaration을 자동으로 추가하지 않으며, 목록 페이지네이션은 content.pageInfo를 유지합니다.

필드 타입 설명
content boolean 항상 true를 반환하며, 매칭이 없거나 빈 배열인 경우에도 true일 수 있습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

파라미터가 선언과 일치하지 않으면 공통 요청 오류를 반환하며, 데이터베이스, 캐시 등 일반적인 내부 예외는 최종적으로 500 ft.InternalServerError로 통일됩니다. 쓰기 요청 실패 후에는 먼저 영속 상태와 캐시를 확인하십시오. 전혀 적용되지 않았다고 보장할 수 없습니다.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드명, 타입 및 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
400 ft.JsonFormatError 요청 JSON 최상위가 객체가 아님 일부 json 파일 형식 오류 삭제 요청은 JSON 객체를 사용하며, workspaceUUIDs는 그 배열 필드입니다.
500 ft.InternalServerError 데이터베이스, 캐시 무효화 또는 명시적으로 처리되지 않은 내부 예외 내부 오류 traceId를 저장하고 Key 현재 상태와 실제 호출 결과를 먼저 확인한 후 재시도를 결정합니다. 데이터베이스가 이미 커밋되었을 수 있으므로 오류 응답만으로 변경이 없었다고 판단할 수 없습니다.

문서 평가

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