콘텐츠로 이동

내보내기



POST /api/v1/pipeline/export

개요

선택한 Pipeline의 마이그레이션 템플릿 JSON을 내보냅니다.

호출 전 확인 사항 및 사용 단계

content.pipelines 배열을 반환하며 파일 다운로드가 아닙니다. 현재 구성의 base64 본문 및 examples를 포함하고 UUID/버전 이력/작업자는 포함하지 않습니다. 먼저 현재 워크스페이스 목록에서 비삭제 UUID를 항목별로 확인해야 하며, 다른 워크스페이스, 템플릿 또는 기타 일치하지 않는 항목을 섞지 마세요. 주 엔터티는 현재 워크스페이스에서만 조회하지만, 연관 조회는 전체 입력을 사용합니다. 내보내기 대상에 포함되지 않은 연관이 포함되어 있으면 조립 시 500이 발생할 수 있습니다. 주 엔터티가 전혀 일치하지 않으면 404를 반환하며, 혼합 입력에서는 유효하지 않은 항목만 무시된다고 보장하지 않습니다. 마이그레이션 전에 대상 데이터 카테고리, source 및 기본값 충돌을 확인하세요. 가져오기는 내보낸 비활성화 상태를 보존하지 않습니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
pipelineUUIDs[*] string 이름을 사용하지 않습니다.
예시: pl_example
가져오기 또는 입력 방법: 현재 워크스페이스의 단일 UUID입니다.
pipelineUUIDs array Y 필수 배열이며, 비어 있지 않은 값을 권장합니다.
null 허용: False
예시: ["pl_example"]
가져오기 또는 입력 방법: Pipeline 목록에서 대상 uuid를 가져옵니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/pipeline/export' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"pipelineUUIDs":["pl_example"]}'

응답

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

필드 유형 설명
content.pipelines array<object> 템플릿 배열입니다.
content.pipelines[].name string 저장 구성: 필수, 최대 256 카운트 단위(ASCII/반각 가타카나는 1, 기타 문자는 2), 영숫자, 밑줄, 중국어 U+4e00..9fa5 및 하이픈을 허용하며, 비어 있지 않은 값을 권장합니다. 동일 category에서는 local/central이 다르거나 기존 항목이 비활성화되어도 중복을 허용하지 않습니다. 입력 로그 source가 아닙니다.
content.pipelines[].type string 저장 구성: 필수 local/central, 신서틱 테스트(dialtesting) 추가/수정은 central만 가능합니다. 워크스페이스 버전에 따라 central이 제한될 수 있습니다. 수정하면 원래 실행 유형이 대체됩니다.
content.pipelines[].category string 저장 구성: 필수 lineage/logging/object/custom_object/network/tracing/rum/llm/agent_monitor/security/keyevent/metric/profiling/dialtesting/cloud_billing, billing은 이전 버전 호환 값입니다. 수정 시 카테고리를 변경할 수 있으며, 스크립트, source 및 extend를 함께 검토해야 합니다.
content.pipelines[].source array 저장 구성: 선택 사항, 기본값 []이며, 수정 시 생략하면 모든 source 관계가 제거됩니다. * 또는 ?를 포함한 source는 정확한 고유성 충돌 검사에 참여하지 않으며, 모든 일치 항목의 런타임 동작을 보장하지 않습니다. 일반적인 정확한 source는 동일한 category/type 내에서 다른 비삭제 Pipeline이 차지할 수 없습니다. rum/llm 추가/수정 시 이 배열은 무시되고 extend.appID와 measurement를 사용합니다.
content.pipelines[].source[] string 저장 구성: 비어 있지 않은 문자열을 권장하며, 배열 항목별 엄격한 검증은 수행하지 않습니다. 관련 없는 데이터 영역을 섞지 마세요.
content.pipelines[].content string 저장 구성: 필수 base64 문자열이며, 추가 시 디코딩 후 비어 있지 않아야 합니다. 디코딩된 스크립트 전체는 UI 문자 수 ≤1048576 및 UTF8 바이트 ≤1048576을 동시에 충족해야 합니다. BMP 비ASCII는 2, 보충 문자는 4로 계산합니다. 둘 중 하나라도 초과하면 ft.ContextExceedLimit입니다. 저장 시 샘플 없이 동기 컴파일을 수행하고 동일 카테고리의 활성화된 스크립트 참조를 확인하지만, 성공이 실제 데이터 디버깅 통과 또는 적용 완료를 의미하지는 않습니다.
content.pipelines[].dataType string 저장 구성: 선택 사항, 기본값 line_protocol, line_protocol/json/message를 지원합니다. 수정 시 생략하면 line_protocol로 복원됩니다. category가 아닙니다. 빈 문자열은 호환된다고 선언되어 있지만 지원되는 값을 명확히 선택해야 합니다.
content.pipelines[].asDefault integer 저장 구성: 선택 사항, 기본값 0, 0/1만 지정하는 것을 권장합니다. 이미 기본값이 있고 isForce가 없으면 HTTP 200으로 confirm 배열을 반환하며, 이번 대상 구성은 저장되지 않으므로 생성/수정 성공으로 간주하지 않습니다.
content.pipelines[].enableByLogBackup integer 저장 구성: 선택 사항, 기본값 0, 0/1 권장. 이 플래그를 저장해도 기존 전송 데이터가 자동으로 재실행되는 것은 보장되지 않습니다.
content.pipelines[].extend json 저장 구성: 선택 사항, 기본값 {}; 수정 시 전체가 대체되며 병합되지 않습니다. rum/llm은 appID×measurement 조합으로 source 관계를 생성합니다. 알 수 없는 하위 필드는 공개 검증에서 거부됩니다.
content.pipelines[].extend.appID array 저장 구성: rum/llm은 measurement와 함께 비어 있지 않은 배열을 제공해야 합니다. 둘 다 비어 있으면 전용 source가 없을 수 있으며, appID가 있고 measurement가 없으면 파라미터 누락 오류가 발생합니다.
content.pipelines[].extend.measurement array 저장 구성: rum/llm은 appID와 카테시안 조합을 만듭니다. measurement가 있지만 appID가 없으면 파라미터 누락 오류가 발생합니다. 저장 시 각 애플리케이션/measurement에 실제 데이터가 있는지 검증하지 않습니다.
content.pipelines[].extend.loggingIndex string 저장 구성: 선택 사항인 로그 인덱스 에코 필드이며, 기본적으로 값을 채우지 않습니다. 수정 시 생략하면 extend와 함께 제거됩니다. source 배열이 아닙니다.
content.pipelines[].extend.ifAiCreate boolean 저장 구성: 선택 사항인 에코 필드이며, AI 작업을 트리거하지 않습니다.
content.pipelines[].extend.aiTargetStructure string 저장 구성: 선택 사항인 문자열이며 저장/에코만 하고, 이 인터페이스는 스크립트를 생성하지 않습니다.
content.pipelines[].extend.exampleSource string 저장 구성: 선택 사항인 에코 필드이며, source 연결을 대체하지 않습니다.
content.pipelines[].extend.exampleType string 저장 구성: 선택 사항인 에코 문자열이며, 서버에서 고정 열거형을 제공하지 않습니다.
content.pipelines[].extend.appID[] string 저장 구성: 비어 있지 않은 문자열을 권장합니다.
content.pipelines[].extend.measurement[] string 저장 구성: 비어 있지 않은 문자열을 권장합니다.
content.pipelines[].isDisable boolean 내보낼 때의 원래 상태입니다. 현재 공개 import는 이 플래그를 적용하지 않으며, 가져온 후 기본적으로 활성화됩니다.
content.pipelines[].examples array<object> 테스트 샘플 배열이며, 각 항목은 개별 base64입니다.
content.pipelines[].examples[] object 단일 샘플입니다.
content.pipelines[].examples[].data string 단일 샘플 UTF8 문자열의 base64입니다. 객체는 JSON으로, 텍스트는 JSON 문자열로 인코딩하여 가져올 때 파싱 손실을 방지합니다.
content.declaration object 공통 선언이며, 가져오기 시 pipelines만 사용합니다.
{
  "code": 200,
  "content": {
    "pipelines": [
      {
        "name": "production_parser",
        "type": "local",
        "category": "logging",
        "asDefault": 0,
        "enableByLogBackup": 0,
        "source": [
          "nginx"
        ],
        "isDisable": false,
        "content": "YWRkX2tleSgiZW52IiwgInByb2R1Y3Rpb24iKQ==",
        "examples": [
          {
            "data": "eyJtZXNzYWdlIjoiZXhhbXBsZSBsb2cifQ=="
          }
        ],
        "dataType": "json",
        "extend": {
          "loggingIndex": "default"
        }
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하세요.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하세요.
406 ft.PipelineNotExist 요청 컬렉션에 현재 워크스페이스의 비삭제 일치 항목이 없음 내보낼 pipeline이 존재하지 않음 목록을 새로 고친 후 다시 내보내세요.
500 ft.InternalServerError 입력에 내보내기 대상에 포함되지 않은 연관 UUID가 섞여 있거나 구성/샘플 조립에 실패함 내부 오류 현재 워크스페이스 목록에서 항목별로 확인한 비삭제 UUID만 사용하여 내보내세요. 계속 실패하면 traceId를 제공하세요.

문서 평가

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