콘텐츠로 이동

조회



GET /api/v1/pipeline/{pl_uuid}/get

개요

Pipeline 스크립트, 샘플, 버전 및 전체 저장 구성을 읽습니다.

호출 전 및 사용 단계

목록에서 uuid를 가져옵니다. 현재 워크스페이스의 삭제되지 않은 구성을 읽을 수 있으며, UUID를 알고 있는 공용 시스템 템플릿(workspaceUUID가 빈 문자열)도 읽을 수 있습니다. 시스템 템플릿이 직접 수정 가능함을 의미하지는 않습니다. content/testData는 여전히 base64이며, 호출자가 UTF-8로 디코딩한 후 편집하고 다시 인코딩하여 제출합니다. rum/llm 상세의 source는 []이며, extend.appID/measurement를 사용해 구조화된 바인딩을 확인합니다. 시스템 템플릿의 source는 템플릿 이름을 사용합니다.

경로 파라미터

파라미터 이름 유형 필수 설명
pl_uuid string Y 현재 워크스페이스의 Pipeline UUID로, 이전 UUID, 이름 또는 숫자 id와 구분됩니다.
예: pl_example
가져오기 또는 입력 방법: Pipeline 목록에서 uuid를 가져옵니다.

요청 헤더

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

요청 예시

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

응답

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

필드 유형 설명
content.id integer 데이터베이스 번호이며, 작업에는 uuid를 사용합니다.
content.uuid string pl_ 객체 UUID입니다.
content.workspaceUUID string 소속 워크스페이스이며, 시스템 템플릿은 빈 문자열입니다.
content.isSysTemplate string / integer / boolean 시스템 템플릿 여부입니다. 엔터티는 Text 컬럼이며 문자열 플래그를 반환할 수 있습니다. 실제 플래그를 기준으로 파싱하고, 문자열이 비어 있지 않은지로 직접 판단하지 마십시오.
content.isCustomSysTemp integer 또는 boolean 사용자 정의 시스템 템플릿 여부입니다.
content.language string 템플릿/구성 언어이며, 빈 문자열일 수 있습니다.
content.status integer 0은 활성화, 2는 비활성화, 3은 삭제입니다.
content.creator string 생성 주체입니다.
content.updator string 최근 업데이트 주체입니다.
content.createAt integer 생성 Unix 초입니다.
content.updateAt integer 업데이트 Unix 초입니다.
content.deleteAt integer 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다.
content.name string 저장 구성: 필수이며 최대 256 계수 단위(ASCII/반각 가타카나 1, 기타 문자 2)입니다. 영문자, 숫자, 밑줄, 중국어 U+4e00..9fa5 및 하이픈을 허용하며, 비어 있지 않을 것을 권장합니다. 동일한 category에서는 local/central이 다르거나 기존 항목이 비활성화되어 있어도 중복을 허용하지 않습니다. 입력 로그 source가 아닙니다.
content.type string 저장 구성: local/central 필수입니다. 신서틱 테스트(dialtesting)의 신규 추가/수정은 central만 가능합니다. 워크스페이스 버전에 따라 central이 제한될 수 있습니다. 수정하면 기존 실행 유형이 대체됩니다.
content.category string 저장 구성: lineage/logging/object/custom_object/network/tracing/rum/llm/agent_monitor/security/keyevent/metric/profiling/dialtesting/cloud_billing 필수입니다. billing은 레거시 호환 값입니다. 수정 시 범주를 변경할 수 있으며, 스크립트, source 및 extend를 함께 확인해야 합니다.
content.source array 저장 구성: 선택 사항이며 기본값은 []입니다. 수정 시 생략하면 모든 소스 관계가 제거됩니다. * 또는 ?를 포함하는 소스는 정확한 고유성 충돌 검사에 참여하지 않으며, 모든 일치 항목의 런타임 동작을 보장하지 않습니다. 일반적인 정확한 소스는 동일한 category/type 내에서 다른 삭제되지 않은 Pipeline이 점유할 수 없습니다. rum/llm의 신규 추가/수정에서는 이 배열을 무시하고 extend.appID와 measurement를 사용합니다.
content.source[] string 저장 구성: 비어 있지 않은 문자열을 권장하며, 배열은 항목별로 엄격하게 검증되지 않습니다. 관련 없는 데이터 영역을 섞지 마십시오.
content.content string 저장 구성: 필수 base64 문자열이며, 신규 추가 시 디코딩 후 비어 있지 않아야 합니다. 디코딩된 스크립트 전체가 UI 문자 수 ≤1048576 및 UTF8 바이트 ≤1048576을 동시에 충족해야 합니다. BMP 비ASCII는 2로 계산하고, 보충 문자는 4로 계산합니다. 둘 중 하나라도 초과하면 ft.ContextExceedLimit입니다. 저장 시 샘플 없이 동기적으로 컴파일하고 동일 범주의 활성화된 스크립트 참조를 검사합니다. 저장 성공이 실제 데이터 디버깅 통과 또는 적용 완료를 의미하지는 않습니다.
content.testData string 저장 구성: 선언은 선택 사항이지만, 신규 추가 시 생략하면 controller가 None을 디코딩할 때 InvalidBase64를 반환할 수 있으므로 항상 W10= 또는 빈 문자열을 명시적으로 제공해야 합니다. 수정 시 생략하면 빈 문자열로 복원됩니다. 공개 add/modify는 빈 문자열, 또는 엄격한 base64 디코딩 결과가 비어 있거나 JSON 배열인 경우만 허용하며, 단일 객체를 직접 인코딩할 수 없습니다. 배열 구성 요소는 문자열 또는 객체를 권장합니다. 숫자/null은 레거시 항목별 길이 검증에서 500을 유발할 수 있습니다. 각 항목의 레거시 제한은 약 20480입니다(객체는 직렬화된 객체 메모리 크기, 문자열은 기존 가중 길이 기준). 이는 스크립트의 1MiB 상한이 아닙니다.
content.dataType string 저장 구성: 선택 사항이며 기본값은 line_protocol입니다. line_protocol/json/message를 지원합니다. 수정 시 생략하면 line_protocol로 복원됩니다. category가 아닙니다. 빈 문자열은 호환된다고 선언되어 있지만, 지원되는 값을 명확히 선택해야 합니다.
content.asDefault integer 저장 구성: 선택 사항이며 기본값은 0이고 0/1만 제공할 것을 권장합니다. 이미 기본값이 있고 isForce가 없으면 HTTP 200에서 confirm 배열을 반환하며, 이번 대상 구성은 저장되지 않으므로 생성/수정 성공으로 간주하지 않습니다.
content.enableByLogBackup integer 저장 구성: 선택 사항이며 기본값은 0이고 0/1을 권장합니다. 저장 플래그가 기존 전송 데이터의 자동 재실행을 보장하지는 않습니다.
content.extend json 저장 구성: 선택 사항이며 기본값은 {}입니다. 수정 시 전체를 교체하며 병합하지 않습니다. rum/llm은 appID×measurement 조합으로 소스 관계를 생성합니다. 알 수 없는 하위 필드는 공개 검증에서 거부됩니다.
content.extend.appID array 저장 구성: rum/llm은 measurement와 함께 비어 있지 않은 배열을 제공해야 합니다. 둘 다 비어 있으면 전용 소스가 없어도 되지만, appID가 있고 measurement가 없으면 누락된 파라미터 오류가 발생합니다.
content.extend.measurement array 저장 구성: rum/llm은 appID와 카티션 곱을 생성합니다. measurement가 있지만 appID가 없으면 누락된 파라미터 오류가 발생하며, 저장 시 각 애플리케이션/measurement에 실제 데이터가 있는지 검증하지 않습니다.
content.extend.loggingIndex string 저장 구성: 선택 사항인 로그 인덱스 응답 필드입니다. 기본적으로 값을 채우지 않으며, 수정 시 생략하면 extend와 함께 제거됩니다. source 배열이 아닙니다.
content.extend.ifAiCreate boolean 저장 구성: 선택 사항인 응답 필드이며, AI 작업을 트리거하지 않습니다.
content.extend.aiTargetStructure string 저장 구성: 선택 사항인 문자열이며 저장 및 응답 표시만 수행합니다. 이 API는 스크립트를 생성하지 않습니다.
content.extend.exampleSource string 저장 구성: 선택 사항인 응답 필드이며, source 연결을 대체하지 않습니다.
content.extend.exampleType string 저장 구성: 선택 사항인 응답 문자열이며, 서버에서 고정 열거형을 제공하지 않습니다.
content.extend.appID[] string 저장 구성: 비어 있지 않은 문자열을 권장합니다.
content.extend.measurement[] string 저장 구성: 비어 있지 않은 문자열을 권장합니다.
content.configVersion integer 현재 구성 버전이며 초기값은 1입니다. 구성에 실제 변경이 발생하면 증가하며, 활성화/비활성화는 구성 스냅샷 필드가 아닙니다.
content.configVersionAt integer 해당 구성 버전이 적용된 기록 시각(Unix 초)입니다.
content.configVersionOperator string 해당 버전의 작업자 주체입니다.
content.configVersionSource string 소스는 예: openapi/console/history/workspace_restore/legacy/system입니다.
content.configVersionAction string 예: create/modify/import/official_clone/current_clone/history_restore/history_clone/default_replace/baseline입니다.
content.configVersionSourceInfo object 소스 작업 정보입니다. 소스가 없으면 {}이며, 필드는 작업에 따라 생략될 수 있습니다.
content.configVersionSourceInfo.templateName string 공식 복제 소스 템플릿 이름입니다.
content.configVersionSourceInfo.pipelineUUID string 소스 Pipeline UUID입니다.
content.configVersionSourceInfo.configVersion integer 소스 구성 버전 번호입니다.
content.configVersionSourceInfo.pipelineHistoryUUID string 히스토리 복제/복원 소스 히스토리 UUID입니다.
content.configVersionSourceInfo.replacedByName string 기본값 교체로 트리거된 새 파일 이름입니다.
content.configVersionSourceInfo.replacedByPipelineUUID string 기본값 교체로 트리거된 Pipeline UUID입니다.
content.declaration object 공용 선언입니다.
{
  "code": 200,
  "content": {
    "id": 100,
    "uuid": "pl_example",
    "workspaceUUID": "wksp_example",
    "name": "production_parser",
    "type": "local",
    "category": "logging",
    "content": "YWRkX2tleSgiZW52IiwgInByb2R1Y3Rpb24iKQ==",
    "testData": "W3sibWVzc2FnZSI6ImV4YW1wbGUgbG9nIn1d",
    "dataType": "json",
    "asDefault": 0,
    "enableByLogBackup": 0,
    "extend": {
      "loggingIndex": "default"
    },
    "isSysTemplate": 0,
    "isCustomSysTemp": 0,
    "language": "",
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427200,
    "deleteAt": -1,
    "configVersion": 1,
    "configVersionAt": 1785427200,
    "configVersionOperator": "wsak_example",
    "configVersionSource": "openapi",
    "configVersionAction": "create",
    "configVersionSourceInfo": {},
    "source": [
      "nginx"
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
404 ft.NotFoundPipelineCfg 현재 워크스페이스의 Pipeline/히스토리가 존재하지 않거나, 삭제되었거나, 해당 주 구성이 삭제됨 지정된 Pipeline 구성을 찾을 수 없습니다. 현재 목록/히스토리 목록에서 UUID를 다시 가져옵니다.
500 ft.InternalServerError 구성 읽기, 신원 정보 또는 응답 인코딩 실패 내부 오류 UUID와 저장된 데이터를 확인하고 잠시 후 다시 시도하십시오. 계속 실패하면 traceId를 제공하십시오.

문서 평가

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