콘텐츠로 이동

템플릿 - 사용자 정의 템플릿 삭제



POST /api/v1/sys_template/custom/{systemplate_uuid}/delete

개요

사용자 정의 시스템 템플릿을 소프트 삭제합니다.

호출 전 및 사용 단계

이것은 사이트 수준 템플릿 라이브러리이며, 특정 워크스페이스에서 이미 생성한 대시보드/모니터/Pipeline 인스턴스가 아닙니다. 라이브러리 템플릿을 삭제하거나 덮어쓰는 것은 이미 인스턴스화된 리소스를 삭제/업그레이드하는 것과 같지 않습니다. 이 모듈은 데이터 조회를 수행하거나 실행 중인 수집 설정을 게시하지 않습니다. w 권한이 필요합니다. 먼저 템플릿 목록에서 isCustomSysTemp=true로 필터링하여 내용과 참조자를 백업하고, 해당 라이브러리 템플릿을 사용하지 않을 것을 확인한 후 제출합니다. 소프트 삭제는 isCustomSysTemp=true인 라이브러리 레코드만 일치시킵니다. Pipeline은 추가로 isSysTemplate=true를 요구합니다. 일치하지 않는 항목, 알 수 없는 UUID, 사용자 정의가 아닌 레코드는 모두 무시되고 true를 반환하므로, true를 근거로 대상이 실제로 존재하거나 삭제되었다고 단정할 수 없습니다. 이미 삭제된 레코드도 다시 일치하여 삭제 시간이 업데이트될 수 있으므로, 재생은 시간을 그대로 유지하는 멱등 작업이 아닙니다. 기존 워크스페이스 인스턴스는 함께 삭제되지 않으며, 항목별 수량/상태는 반환되지 않습니다. 삭제 후 목록/상세를 다시 확인하십시오. 상세에서 알 수 없는 식별된 접두사는 content=null일 수 있으며, 반드시 404여야 하는 것은 아닙니다.

라우트 매개변수

매개변수명 유형 필수 설명
systemplate_uuid string Y 프로토콜 이름은 과거 표기인 systemplate_uuid를 유지합니다. 단일 pl_은 시스템/사용자 정의 템플릿이기도 해야 하며, 나머지는 사용자 정의 Integration으로 조회합니다.
예: itgr_example001
가져오기 또는 입력 방법: 템플릿 목록에서 isCustomSysTemp=true로 필터링하여 uuid를 가져오며, 앞뒤 공백을 추가하지 않습니다.

요청 헤더

매개변수명 유형 필수 설명
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 초 문자열을 생성합니다.

매개변수 추가 설명

소프트 삭제는 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/itgr_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"))

응답

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 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 매개변수 파싱 실패 매개변수 위치, 필드 이름, 유형 및 값을 확인하십시오.
500 ft.InternalServerError jsonContents 요소/동적 필드 유형 오류, Base64 이외의 검증되지 않은 구조, 데이터베이스 저장/삭제 예외 내부 오류 먼저 템플릿 목록과 상세에서 현재 상태를 확인한 후 재시도하십시오. HTTP200 진단은 500과 다르며, 오류는 항목별 쓰기 UUID를 제공하지 않습니다. traceId를 보존하고, 무작정 반복해서 덮어쓰지 마십시오.

문서 평가

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