콘텐츠로 이동

삭제



GET /api/v1/pipeline/delete

개요

Pipeline 및 해당 소스 연관 관계를 일괄 소프트 삭제합니다.

호출 전 및 사용 단계

파라미터는 URL Query에 있으며, 현재 워크스페이스 목록에서 항목별로 확인한 후 유효한 UUID를 영문 쉼표로 연결해야 하며, 다른 워크스페이스, 시스템 템플릿 또는 기타 일치하지 않는 식별자를 혼합해서는 안 됩니다. 현재 워크스페이스의 기본 구성이 하나 이상 일치한 후 연관 삭제는 전체 입력 UUID를 기준으로 조회하며, 기본 객체가 일치하지 않았다고 해서 해당 연관 관계가 반드시 영향을 받지 않았다고 이해해서는 안 됩니다. 현재 구성과 조회된 해당 연관 관계를 소프트 삭제하며, 이미 처리된 데이터는 삭제하지 않고 모든 이력 저장소를 즉시 삭제하지도 않습니다. 기본 구성이 삭제된 후에는 이력 읽기/복구도 사용할 수 없습니다. null 값/알 수 없는 UUID도 true로 성공할 수 있으므로, 응답으로 삭제 수를 집계해서는 안 됩니다.

이는 레거시 GET 삭제 인터페이스로, 호출 시 구성이 변경되므로 부작용 없는 조회나 자동 프리페치 링크로 사용해서는 안 됩니다. 먼저 구성 백업을 저장하고 삭제 범위를 명확히 한 후 호출하십시오.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 유형 필수 설명
pipelineUUIDs commaArray Y 필수 쉼표 구분 문자열이며 Body 배열이 아닙니다. 비어 있지 않은 값을 권장하며, 일치하는 항목이 없어도 404를 반환하지 않습니다.
null 허용: False
예시: pl_example
확인 또는 입력 방법: Pipeline 목록에서 uuid를 가져오며, 여러 개는 영문 쉼표로 연결합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/pipeline/delete?pipelineUUIDs=pl_example' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content boolean 성공 시 true이며, 삭제 수가 아닙니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인하십시오.
500 ft.InternalServerError 데이터베이스 액세스, 커밋 또는 이력 데이터 구조 이상 내부 오류 먼저 목록과 상세 정보를 통해 대상 구성의 삭제 상태를 다시 조회하여 적용되었는지 확인한 후 재시도 여부를 결정하십시오. 지속적으로 실패하면 traceId를 제공하십시오.

문서 평가

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