템플릿 - 사용자 정의 템플릿 일괄 삭제¶
POST /api/v1/sys_template/custom/batch_deletes
개요¶
사용자 정의 시스템 템플릿을 일괄 소프트 삭제합니다.
호출 전 확인 및 사용 단계¶
이것은 사이트 수준 템플릿 라이브러리이며, 특정 워크스페이스에 이미 생성된 대시보드/모니터/Pipeline 인스턴스가 아닙니다. 라이브러리 템플릿을 삭제하거나 덮어쓰는 것은 이미 인스턴스화된 리소스를 삭제/업그레이드하는 것과 같지 않습니다. 이 모듈은 데이터 쿼리를 실행하거나 실행 중인 수집 설정을 게시하지 않습니다. w 권한이 필요합니다. 먼저 템플릿 목록에서 isCustomSysTemp=true로 필터링하여 내용 및 참조하는 쪽을 백업하고, 해당 라이브러리 템플릿을 사용하지 않음을 확인한 후 제출합니다. 소프트 삭제는 isCustomSysTemp=true인 라이브러리 레코드만 일치합니다. Pipeline은 추가로 isSysTemplate=true여야 합니다. 일치하지 않는 항목, 알 수 없는 UUID, 사용자 정의가 아닌 레코드는 모두 무시되고 true를 반환합니다. true만으로 대상이 실제로 존재하거나 삭제되었다고 단정할 수 없습니다. 이미 삭제된 레코드도 다시 일치하여 삭제 시간을 갱신할 수 있으므로, 재요청은 삭제 시간을 그대로 유지하는 멱등 작업이 아닙니다. 기존 워크스페이스 인스턴스는 함께 삭제되지 않습니다. 항목별 개수/상태는 반환되지 않습니다. 삭제 후 목록/상세를 다시 조회하여 확인합니다. 상세에서 알 수 없는 인식된 접두사는 content=null일 수 있으며, 반드시 404여야 하는 것은 아닙니다.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 원본 경로와 요청 본문의 서명 버전입니다. 생략한 뒤 이 페이지의 알고리즘을 계속 사용할 수는 없습니다. 예: v20240417가져오기 또는 입력 방법: 이 페이지의 예제는 이 고정 버전을 사용하며 예제 서명 알고리즘과 함께 사용됩니다. |
|
| X-Df-Access-Key | string | Y | 읽기 API는 r 또는 w 자격 증명을 사용할 수 있고, 쓰기 API는 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 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| systemplateUUIDs[*] | string | 단일 itgr_ 또는 pl_ 템플릿 UUID입니다. Pipeline은 추가로 isSysTemplate=true여야 하며, 일반 워크스페이스 Pipeline은 이 삭제 대상이 아닙니다. 예: itgr_example001가져오기 또는 입력 방법: 템플릿 목록에서 단일 사용자 정의 템플릿 uuid를 가져옵니다. |
|
| systemplateUUIDs | array | Y | 필수 배열입니다. 각 항목은 먼저 strip한 뒤 접두사별로 그룹화하여 중복 제거하며, 빈 문자열은 무시합니다. []이면 삭제할 항목이 없어도 true를 반환합니다. 문자열이 아닌 요소는 500이 발생할 수 있으며, 외부 비즈니스 리소스 UUID를 사용할 수 없습니다. null 허용: False 예: ["itgr_example001"]가져오기 또는 입력 방법: 템플릿 목록에서 isCustomSysTemp=true로 필터링하여 템플릿 uuid 배열을 가져옵니다. |
파라미터 추가 설명¶
소프트 삭제는 isCustomSysTemp=true인 라이브러리 레코드만 일치합니다. Pipeline은 추가로 isSysTemplate=true여야 합니다. 일치하지 않는 항목, 알 수 없는 UUID, 사용자 정의가 아닌 레코드는 모두 무시되고 true를 반환합니다. true만으로 대상이 실제로 존재하거나 삭제되었다고 단정할 수 없습니다. 이미 삭제된 레코드도 다시 일치하여 삭제 시간을 갱신할 수 있으므로, 재요청은 삭제 시간을 그대로 유지하는 멱등 작업이 아닙니다. 기존 워크스페이스 인스턴스는 함께 삭제되지 않습니다. 항목별 개수/상태는 반환되지 않습니다.
요청 예제¶
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/sys_template/custom/batch_deletes'
query = {}
data = {'systemplateUUIDs': ['itgr_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"))
응답¶
HTTP200, application/json 표준 External 래퍼입니다. content는 이 페이지의 분기에 따라 객체/배열/null/true이며, OpenAPI declaration에 자동으로 추가되지 않고, 목록 페이지네이션은 content.pageInfo에 있습니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 프로세스가 완료되면 true로 고정되며, 항목별 삭제 결과/개수는 없습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다. | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아닙니다. | 일부 json 파일 형식 오류 | systemplateUUIDs 배열이 포함된 JSON 객체를 제출합니다. |
| 500 | ft.InternalServerError | jsonContents 요소/동적 필드 유형 오류, Base64 이외의 미검증 구조, 데이터베이스 저장/삭제 예외 | 내부 오류 | 먼저 템플릿 목록과 상세에서 현재 상태를 확인한 후 재시도합니다. HTTP200 진단은 500과 다르며, 오류 시 항목별 기록 UUID를 제공하지 않습니다. traceId를 보존하고 무작정 반복해서 덮어쓰지 않습니다. |