삭제¶
POST /api/v1/workspace/{workspace_uuid}/delete
개요¶
워크스페이스를 삭제 상태로 표시하고 쓰기를 잠그며, 지연 정리 절차에 진입합니다.
호출 전 확인 및 사용 단계¶
먼저 워크스페이스 목록에서 워크스페이스 이름과 UUID를 확인하고, 백업, 수집 측 전환 및 멤버 영향을 확인합니다. 이 인터페이스는 요청 본문이 필요 없으며, 호출 후 즉시 삭제 표시 및 잠금이 적용되고 관련 Token과 기본 워크스페이스 참조가 정리되며, 데이터 권한 정리, 워크스페이스 작업 일시 중지 및 알림 전송이 비동기로 수행됩니다. 비즈니스 데이터는 지연 정리 작업에서 이후에 삭제됩니다. 저장소 기본값은 7일이며, 실제로는 사이트의 clearDataSet과 작업 실행 시간을 기준으로 하고, 유예 기간을 백업으로 간주할 수 없습니다. 복구가 필요한 경우 정리 전에 관리자에게 문의하여 복구 절차를 진행해야 하며, 이 인터페이스는 복구를 담당하지 않습니다. 이미 삭제된 워크스페이스를 다시 삭제하면 찾을 수 없음이 반환되며, 이는 멱등 성공이 아닙니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| workspace_uuid | string | Y | 대상 워크스페이스 UUID이며, 계정 UUID도 아니고 수집 Token도 아닙니다. 예시: wksp_example001획득 또는 입력 방법: 워크스페이스 목록의 content.data[].uuid 또는 생성 성공 시의 content.wsInfo.uuid에서 가져오고, 사이트와 워크스페이스 이름을 확인합니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 예시와 동일하게 유지해야 하며, 생략한 뒤 이 알고리즘을 계속 사용할 수 없습니다. 예시: v20240417획득 또는 입력 방법: 이 페이지의 원본 경로 및 요청 본문 서명 알고리즘에 맞춰 입력합니다. |
|
| X-Df-Access-Key | string | Y | 여기의 7개 항목은 모두 쓰기 작업이므로 External 쓰기 권한이 필요합니다. 예시: <external-access-key>획득 또는 입력 방법: 사이트 관리자가 w 권한이 있는 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>획득 또는 입력 방법: 함께 제공된 SK로 External API 서명 인증 및 아래 Python 템플릿에 따라 계산합니다. |
| X-Df-Timestamp | string | Y | 예시의 고정 시간을 재사용할 수 없으며, 사이트 서명 유효 기간 내에 있어야 합니다. 예시: 1785427200획득 또는 입력 방법: 전송 시 str(int(time.time()))로 현재 Unix 초를 생성합니다. |
파라미터 추가 설명¶
w 권한이 있는 사이트 수준 External API 자격 증명을 사용합니다. 인증 방식은 External API 서명 인증을 참조하십시오. 예시는 v20240417 기준으로 서명을 계산하며, 서명과 전송에는 동일한 경로, Query 및 원본 요청 본문을 사용합니다. 모든 예시는 데모 값이므로 실행 전에 실제 대상으로 교체해야 합니다. 쓰기 요청이 타임아웃되거나 500이 발생하면 먼저 현재 상태를 조회한 후 확인하고 재시도 여부를 결정해야 합니다. 반환되는 것은 표시된 이후의 워크스페이스 스냅샷이며, 모든 백그라운드 정리가 완료되었음을 의미하지 않습니다. 라이프사이클 잠금 또는 다운스트림 상태가 비정상인 경우 워크스페이스는 이미 삭제 표시되었으나 후속 알림이 완료되지 않았을 수 있으므로, 현재 상태에 따라 복구 또는 보정해야 합니다.
요청 예시¶
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/wksp_example001/delete'
query = {}
data = None
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을 자동 주입하지 않습니다. 워크스페이스 객체의 declaration은 해당 객체가 자체 저장하는 필드입니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 사이트 내 레코드 일련번호이며, 이후 호출에는 uuid를 사용합니다. |
| content.uuid | string | 워크스페이스 UUID입니다. |
| content.status | integer | 0은 정상, 3은 삭제 표시됨이며, 삭제 응답 스냅샷은 3입니다. |
| content.creator | string | 생성 주체 식별자이며, External 생성은 보통 sys입니다. |
| content.updator | string | 최근 수정 주체이며, 수정되지 않은 경우 비어 있을 수 있습니다. |
| content.createAt | integer | 생성 시간, Unix 초. |
| content.deleteAt | integer | 삭제 시간, Unix 초, 삭제되지 않은 경우 보통 -1. |
| content.updateAt | integer | 업데이트 시간, Unix 초, 아직 수정되지 않은 경우 보통 -1. |
| content.name | string | 워크스페이스 표시 이름. |
| content.token | string | 워크스페이스 기본 수집 Token. 자격 증명으로 저장되며 External AK/SK로 사용할 수 없습니다. 예시는 자리 표시자 값을 사용합니다. |
| content.cliToken | string | 워크스페이스 CLI 자격 증명으로, 자격 증명으로 저장됩니다. 예시에는 실제 값이 포함되지 않습니다. |
| content.dbUUID | string | 메트릭 데이터베이스 레코드 UUID. |
| content.esInstanceUUID | string | 실제 로그 저장 인스턴스 UUID. |
| content.dashboardUUID | string | 워크스페이스 기본 뷰 식별자이며, 설정되지 않은 경우 비어 있습니다. |
| content.exterId | string | 외부 시스템 워크스페이스 식별자이며 보통 비어 있습니다. 이 페이지에서 쓸 수 있는 필드가 아닙니다. |
| content.rpName | string | 메트릭 보존 정책의 내부 별칭이며, durationSet.rp를 대체하여 사용하지 마십시오. |
| content.desc | string | 워크스페이스 설명. |
| content.durationSet | object 또는 null | 데이터 유형별로 저장된 표준 저장 기간이며, 키는 엔진, 버전 및 인덱스 병합 상태에 따라 달라지고 값은 예를 들어 7d입니다. |
| content.storagePolicy | object 또는 null | 데이터 유형별로 저장된 장기 저장 정책이며, 여기의 장기 정책은 표준 durationSet과 구분됩니다. |
| content.datastore | object 또는 null | 데이터 유형별로 저장된 실제 저장 엔진이며, 예를 들어 metric=guancedb, logging=doris입니다. |
| content.lastDqlDataCheckTime | object 또는 null | 데이터 유형별로 기록된 최근 DQL 데이터 검사 정보이며, 시스템이 유지 관리하는 동적 객체입니다. |
| content.declaration | object 또는 null | 워크스페이스 자체의 조직 및 비즈니스 선언으로 organization, business를 포함할 수 있습니다. 이는 워크스페이스 컬럼이며 External 공통 응답에 자동 주입되는 필드가 아닙니다. |
| content.esIndexSettings | object 또는 null | 데이터 유형별로 저장된 인덱스 설정 객체이며, 빈 객체는 워크스페이스 수준 사용자 정의 템플릿이 없음을 의미하며 다운스트림에 기본 템플릿이 없음을 의미하지는 않습니다. |
| content.bindInfo | object 또는 null | 워크스페이스 브랜드 문구, 메일 및 도메인 재정의 객체이며, 키 정의는 바인딩 정보 설정을 참조하십시오. |
| content.versionType | string | 워크스페이스 버전이며, 예를 들어 free, freeEdition, pay, enterprise, unlimited입니다. 생성 시 사이트 설정을 따르며, 이 인터페이스는 버전 입력 파라미터를 제공하지 않습니다. |
| content.billingState | string | 과금 상태 식별자이며, 예를 들어 free, normal, arrearage, expired, unlimited입니다. |
| content.bossStation | string | 청구 센터 노드 식별자이며, 예를 들어 CN, SG 또는 빈 문자열입니다. |
| content.brandKey | string | 워크스페이스 브랜드 식별자. |
| content.enablePublicDataway | integer | 공용 Dataway 허용 여부, 1은 사용, 0은 사용 안 함. |
| content.isOpenLogMultipleIndex | integer 또는 boolean | 새 로그 다중 인덱스 생성 허용 여부, 1은 사용, 0은 사용 안 함이며, 기존 인덱스는 이로 인해 삭제되지 않습니다. |
| content.esIndexMerged | integer | 인덱스 병합 여부, 1은 병합, 0은 분리. |
| content.supportJsonMessage | integer | JSON 메시지 지원 표시, 1은 사용, 0은 사용 안 함. |
| content.isLocked | integer | 워크스페이스 잠금 표시, 1은 잠김, 0은 잠기지 않음. |
| content.lockMode | string | 잠금 모드이며, 예를 들어 none, writeLocked입니다. |
| content.lockAt | integer | 잠금 시간, Unix 초, 설정되지 않은 경우 보통 -1. |
| content.delayDeleteAt | integer | 지연 정리 기준 시각, Unix 초, 정리 대기 절차에 있지 않은 경우 보통 -1. |
| content.inviteAudit | integer | 멤버 초대 검토 활성화 여부, 1은 사용, 0은 사용 안 함. |
| content.makeResourceExceptionCode | string | 리소스 초기화 문제 표시이며 비어 있을 수 있습니다. 생성 절차에서는 content 최상위에도 최신 문제 표시를 반환합니다. |
| content.loggingCutSize | integer | 초대형 로그 분할 단위, 바이트. |
| content.language | string | 워크스페이스 언어 식별자. |
| content.noviceGuide | boolean | 초보자 가이드 표시. |
| content.timezone | string | 워크스페이스 시간대, 설정되지 않은 경우 비어 있습니다. |
| content.menuStyle | string | 메뉴 스타일 식별자, 설정되지 않은 경우 비어 있습니다. |
| content.tenantId | integer | 워크스페이스 테넌트 ID이며, 생성 응답은 테넌트 ID 생성 전에 스냅샷을 찍으므로 -1일 수 있고, 이후 상세에서 최종 값을 읽습니다. |
| content.isOpenCustomMappingRule | integer | 사용자 정의 매핑 규칙 스위치, 1은 사용, 0은 사용 안 함. |
| content.enableRumMultipleTable | integer | RUM 테이블 분리 스위치, 1은 사용, 0은 사용 안 함. |
| content.enableMFA | boolean | MFA 요구 여부. |
| content.disableQueryAcceleration | integer | 쿼리 가속 비활성화 표시, 1은 비활성화, 0은 비활성화하지 않음. |
| content.disableDataWrite | integer | 쓰기 비활성화 표시, 1은 비활성화, 0은 비활성화하지 않음. |
| content.disableDataWriteAt | integer | 쓰기 금지 시간, Unix 초, 아직 설정되지 않은 경우 보통 -1. |
| content.logBackupQueryTimeLimit | integer | 백업 로그 조회 기간 제한 값, 단위는 시간. |
| content.engineSetting | object | 엔진 전용 설정 동적 객체이며, 기존 nodegroup 필드는 출력에서 node_group으로 정규화됩니다. |
| content.enableAI | boolean | 워크스페이스 AI 전체 스위치. |
| content.enableAPIKeySecurityDisplayPolicy | boolean | API Key 보안 표시 정책 스위치. |
| content.enableObsyAISubscriptionBilling | boolean | Obsy AI 구독 과금 스위치. |
| content.tokenIpSet | object 또는 null | 워크스페이스 Token의 IP 액세스 제한 설정 동적 객체이며, 이 페이지에서는 반환만 하고 이 요청 파라미터로 수정할 수 없습니다. |
| content.singleConfig | object 또는 null | 워크스페이스 기능 설정 동적 객체이며, 워크스페이스의 기존 설정을 기준으로 하며 여기서 고정 설정 키를 보장하지 않습니다. |
| content.issueUpgrade | boolean | 인시던트 에스컬레이션 기능 스위치. |
| content.durationSet.{데이터 유형} | string | 해당 데이터 유형의 표준 보존 기간이며, 예를 들어 rp, logging, keyevent, tracing, rum, apm, network, backup_log입니다. 현재 설정에 따라 다른 읽기 전용 키가 있을 수 있습니다. |
| content.storagePolicy.{데이터 유형} | object | 해당 유형의 장기 정책이며, 주로 rp, logging을 사용합니다. |
| content.storagePolicy.{데이터 유형}.longStorageEnabled | boolean | 장기 저장 활성화 여부. |
| content.storagePolicy.{데이터 유형}.longStorageDuration | string | 장기 총 보존 기간이며, 예를 들어 180d입니다. 비활성화하면 보통 빈 문자열입니다. |
| content.datastore.{데이터 유형} | string | 해당 유형에서 사용하는 엔진 이름이며, 예를 들어 es, doris, scopedb, volctls, sls, guancedb입니다. 인스턴스 UUID가 아닙니다. |
| content.declaration.organization | string | 조직 이름이며, 선언 설정이 있는 경우 제공됩니다. |
| content.declaration.business | string | 비즈니스 설명이며, 선언 설정이 있는 경우 제공됩니다. |
| content.esIndexSettings.{데이터 유형} | object | 해당 유형의 인덱스 설정. |
| content.esIndexSettings.{데이터 유형}.number_of_shards | integer | 기본 샤드 수이며, 표시 여부는 엔진에 따라 다릅니다. |
| content.esIndexSettings.{데이터 유형}.number_of_replicas | integer | 복제본 수. |
| content.esIndexSettings.{데이터 유형}.rollover_max_size | integer | 샤드 롤오버 임계값이며, 인터페이스는 엔진 정의에 따라 그대로 전달합니다. |
| content.esIndexSettings.{데이터 유형}.hot_retention | integer | 핫 데이터 보존 기간, 시간. |
| content.esIndexSettings.{데이터 유형}.cold_retention | integer | 선택적 콜드 데이터 보존 기간, 시간. |
| content.esIndexSettings.{데이터 유형}.archive_retention | integer | 선택적 아카이브 데이터 보존 기간, 시간. |
| content.esIndexSettings.{데이터 유형}.openAdvancedConfig | integer | 고급 설정 표시, 보통 0 또는 1. |
| content.engineSetting.node_group | string | 선택적 엔진 노드 그룹 식별자이며, 기타 설정 항목은 해당 엔진이 결정합니다. |
| content.bindInfo.{설정 항목} | JSON 값 | 기존 브랜드 재정의 값이며, 키 의미는 바인딩 정보 설정 인터페이스를 따릅니다. |
| content.lastDqlDataCheckTime.{데이터 유형} | JSON 값 | 해당 유형의 시스템 유지 관리 검사 값이며, 쿼리 결과가 아닙니다. |
| content.tokenIpSet.{설정 항목} | JSON 값 | 기존 Token IP 정책이며, 읽은 후 그 구조를 유지하고 이를 근거로 External 인증 헤더를 구성하지 않습니다. |
| content.singleConfig.{설정 항목} | JSON 값 | 기존 기능 설정 값이며, 구체적인 유형과 키는 해당 기능 설정 규약을 따릅니다. |
| content.committed | boolean | 일부 동기 409 오류에서만 반환됩니다. true는 삭제 표시됨, false는 이번에 저장되지 않음입니다. |
| content.syncStatus | string | 동기 오류에서만 제공되며, 보통 pending입니다. |
| content.syncRequiresVerification | boolean | 일부 동기 오류에서 제공되며, true이면 먼저 다운스트림 결과를 검증해야 합니다. |
| content.syncFailureReason | string | 일부 동기 오류에서 제공되며, 예를 들어 kodo_timeout, kodo_failed, verification_required입니다. |
{
"code": 200,
"content": {
"id": 1001,
"uuid": "wksp_example001",
"status": 3,
"creator": "sys",
"updator": "sys",
"createAt": 1785427200,
"deleteAt": 1785427200,
"updateAt": 1785427200,
"name": "API 예시 워크스페이스",
"token": "<workspace-token>",
"cliToken": "<workspace-cli-token>",
"dbUUID": "ifdb_example001",
"esInstanceUUID": "esinst_example001",
"dashboardUUID": "",
"exterId": "",
"rpName": "",
"desc": "인터페이스 문서 데모 워크스페이스",
"durationSet": {
"rp": "7d",
"logging": "7d",
"keyevent": "7d",
"tracing": "7d",
"rum": "7d",
"network": "1d"
},
"storagePolicy": {},
"datastore": {
"metric": "guancedb",
"logging": "doris",
"keyevent": "doris",
"tracing": "doris",
"rum": "doris",
"network": "doris",
"lineage": "doris"
},
"lastDqlDataCheckTime": {},
"declaration": {
"organization": "예시 조직",
"business": ""
},
"esIndexSettings": {},
"bindInfo": {},
"versionType": "unlimited",
"billingState": "normal",
"bossStation": "",
"brandKey": "guance",
"enablePublicDataway": 1,
"isOpenLogMultipleIndex": 1,
"esIndexMerged": 0,
"supportJsonMessage": 1,
"isLocked": 1,
"lockMode": "writeLocked",
"lockAt": -1,
"delayDeleteAt": 1785427200,
"inviteAudit": 0,
"makeResourceExceptionCode": "",
"loggingCutSize": 10240,
"language": "zh",
"noviceGuide": false,
"timezone": "",
"menuStyle": "",
"tenantId": -1,
"isOpenCustomMappingRule": 0,
"enableRumMultipleTable": 1,
"enableMFA": false,
"disableQueryAcceleration": 0,
"disableDataWrite": 0,
"disableDataWriteAt": -1,
"logBackupQueryTimeLimit": 24,
"engineSetting": {},
"enableAI": false,
"enableAPIKeySecurityDisplayPolicy": false,
"enableObsyAISubscriptionBilling": false,
"tokenIpSet": {},
"singleConfig": {},
"issueUpgrade": true
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
아래 표는 이 인터페이스의 비즈니스 검증 및 확인된 주요 오류 분기를 나열합니다. 다운스트림 서비스는 구체적인 오류 매핑에 따라 다른 4xx 오류를 반환할 수도 있으며, 일반적인 5xx 및 알 수 없는 예외는 전역 처리에 의해 ft.InternalServerError로 반환됩니다. 쓰기 요청은 현재 설정과 오류 content를 결합하여 적용 여부를 판단해야 하며, HTTP 상태만으로 롤백을 추론할 수 없습니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 406 | ft.NotFoundWorkspace | UUID가 존재하지 않거나 이미 status=3이며 최초 조회에서 찾지 못함 | 지정된 워크스페이스를 찾을 수 없음 | 워크스페이스 목록에서 유효한 UUID를 다시 가져오고 상태를 확인합니다. |
| 401 | ft.WKSPNotExistOrReleased | 최초 조회에서 0도 3도 아닌 이전 상태의 워크스페이스를 찾았으나, 라이프사이클 잠금 내에서 status=0을 요구함 | 워크스페이스가 존재하지 않음/또는 이미 릴리스됨 | 먼저 관리자에게 워크스페이스 라이프사이클 상태를 확인하십시오. 삭제를 반복 제출하지 마십시오. |
| 400 | ft.InvalidAction | 사이트 시스템 워크스페이스를 삭제하려고 시도함 | 유효하지 않은 작업 | 시스템 워크스페이스는 유지하고, 먼저 관리자에게 워크스페이스 용도를 확인하십시오. |
| 409 | ft.WorkspaceTokenSyncPending | 워크스페이스에 동기화 대기 중인 Token이 있거나, 워크스페이스 삭제 표시 후 Token 동기화가 실패함 | 분기에 따라 "이번 작업은 저장되지 않음" 또는 "변경이 저장됨" 동기화 안내를 반환 | content.committed를 구분하고 먼저 워크스페이스 status와 동기화 결과를 확인하십시오. 이미 삭제 표시된 경우 삭제를 반복하지 마십시오. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 리소스 서비스 또는 처리되지 않은 파라미터 변환 예외 | 내부 오류 | traceId를 저장하여 관리자에게 문의하십시오. 먼저 설정과 다운스트림 실제 상태를 조회하고, 실패 응답을 곧바로 저장되지 않은 것으로 간주하지 말고, 무작정 반복 생성 또는 로테이션하지 마십시오. |