수정¶
POST /api/v1/pipeline/{pl_uuid}/modify
개요¶
Pipeline 구성을 전체적으로 수정하고 이력을 보존합니다.
호출 전 준비 및 사용 단계¶
먼저 상세 정보를 읽어 백업하고, 현재 configVersion과 전체 쓰기 가능 필드를 포함해 제출합니다. 이 엔드포인트는 전체를 교체합니다. source, extend, asDefault, enableByLogBackup, testData, dataType을 생략하면 빈 배열/객체, 0, 빈 문자열, line_protocol 등의 기본값으로 바뀌며, 기존 status는 유지됩니다. 실제 구성이 변경된 경우에만 기존 버전을 아카이브하고 버전을 증가시키며, 완전히 동일한 구성은 저장해도 새 버전을 만들지 않습니다. modify 응답의 source는 관계 업데이트 차이 요약일 뿐이며, 제거된 소스가 포함되거나 교집합이 누락될 수 있으므로 다시 get한 최종 source를 대신할 수 없습니다.
기본값 충돌 시에는 먼저 HTTP 200과 비어 있지 않은 content.confirm을 반환하며 정상 엔터티는 없습니다. 사람이 확인한 뒤에만 동일한 구성으로 isForce=true를 지정해 재시도합니다. 강제 교체는 기존 기본값을 비기본값으로 내리고 해당 버전을 아카이브합니다.
저장 시에는 동기적으로 구문을 검증하고 구성/버전을 갱신합니다. 실제 수집 또는 센터 처리의 적용은 이후 구성 조회 및 데이터 흐름에 따라 결정됩니다. 과거 데이터를 다시 실행하지 않으며 파싱 샘플 결과를 반환하지 않습니다. 수정 전에 상세 정보를 백업하고, 오류/타임아웃 발생 시 현재 버전을 먼저 다시 읽은 후 재시도합니다.
라우트 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| 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를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| source[*] | string | 비어 있지 않은 문자열을 권장하며 배열은 항목별로 엄격히 검증되지 않습니다. 관련 없는 데이터 영역을 섞지 마십시오. 예: nginx얻는 방법 또는 입력 방법: 단일 실제 소스 식별자 또는 수집 측에서 지원하는 와일드카드 패턴입니다. |
|
| extend.appID[*] | string | 비어 있지 않은 문자열을 권장합니다. 예: appid_example얻는 방법 또는 입력 방법: 애플리케이션 구성에서 단일 appId를 가져옵니다. |
|
| extend.measurement[*] | string | 비어 있지 않은 문자열을 권장합니다. 예: view얻는 방법 또는 입력 방법: 실제 measurement 원본 이름입니다. |
|
| asDefault | int | 선택 사항이며 기본값은 0이고 0/1만 지정할 것을 권장합니다. 이미 기본값이 있고 isForce가 아니면 HTTP 200과 함께 confirm 배열을 반환하며, 이번 대상 구성은 저장되지 않았으므로 생성/수정 성공으로 간주하지 않습니다. null 허용: False 예: 0얻는 방법 또는 입력 방법: 같은 category/type의 폴백 규칙으로 사용하려면 1, 아니면 0입니다. |
|
| category | string | Y | 필수: lineage/logging/object/custom_object/network/tracing/rum/llm/agent_monitor/security/keyevent/metric/profiling/dialtesting/cloud_billing이며 billing은 과거 호환 값입니다. 수정 시 카테고리를 변경할 수 있으며 스크립트, source, extend를 함께 검토해야 합니다. 빈 문자열 허용: False null 허용: False 선택 가능 값: ['lineage', 'logging', 'object', 'custom_object', 'network', 'tracing', 'rum', 'llm', 'agent_monitor', 'security', 'keyevent', 'metric', 'profiling', 'dialtesting', 'billing', 'cloud_billing', 'keyevent'] 예: logging얻는 방법 또는 입력 방법: 대상 데이터 영역 및 수집 구성에 따라 선택합니다. |
| configVersion | integer | 수정 시 선택 사항이지만 ≥1 정수를 전달할 것을 강력히 권장하며, 이력 복원 시에는 현재 버전이 필수입니다(대상 이력 버전이 아님). 현재 값과 일치하지 않으면 HTTP 409를 반환하므로 다시 읽고 변경 사항을 병합한 후 제출합니다. null 허용: False $minValue: 1 예: 1얻는 방법 또는 입력 방법: 현재 상세 정보의 content.configVersion 또는 이력 첫 화면의 currentPipelineInfo.configVersion에서 가져옵니다. |
|
| content | string | Y | 필수 base64 문자열이며, 새로 추가 시 디코딩 결과가 비어 있지 않아야 합니다. 디코딩된 스크립트 전문은 UI 문자 수 ≤1048576과 UTF8 바이트 ≤1048576을 동시에 만족해야 합니다. BMP 비ASCII 문자는 2, 보충 문자는 4로 계산합니다. 어느 하나라도 초과하면 ft.ContextExceedLimit입니다. 저장 시 샘플 없이 동기 컴파일하고 동일 카테고리의 활성 스크립트 참조를 검사하지만, 성공이 실제 데이터 디버깅 통과나 적용 완료를 의미하지는 않습니다. null 허용: False 예: YWRkX2tleSgiZW52IiwgInByb2R1Y3Rpb24iKQ==얻는 방법 또는 입력 방법: 먼저 UTF8 Pipeline 스크립트를 작성한 뒤 표준 base64 인코딩을 수행합니다. 예시를 디코딩하면 add_key("env", "production")입니다. |
| dataType | string | 선택 사항이며 기본값은 line_protocol이고 line_protocol/json/message를 지원합니다. 수정 시 생략하면 line_protocol로 복원되며 category가 아닙니다. 빈 문자열은 호환으로 선언되어 있지만 지원되는 값을 명확히 선택해야 합니다. 빈 문자열 허용: True null 허용: False 선택 가능 값: ['line_protocol', 'json', 'message'] 예: json얻는 방법 또는 입력 방법: testData 샘플과 스크립트 입력에 따라 선택합니다. |
|
| enableByLogBackup | int | 선택 사항이며 기본값은 0이고 0/1을 권장합니다. 이 플래그를 저장해도 기존 전송 데이터가 자동으로 다시 실행되지는 않습니다. null 허용: False 예: 0얻는 방법 또는 입력 방법: 규칙으로 전송 데이터를 처리해야 하면 1로 설정하고, 실제 데이터 전송 체인에서 지원 여부를 확인합니다. |
|
| extend | json | 선택 사항이며 기본값은 {}입니다. 수정 시 전체를 교체하며 병합하지 않습니다. rum/llm은 appID×measurement 조합으로 소스 관계를 생성하며, 알 수 없는 하위 필드는 공개 검증에서 거부됩니다. null 허용: False 예: {"loggingIndex": "default"}얻는 방법 또는 입력 방법: 카테고리와 기존 상세 정보에 따라 아래 선언 필드를 구성합니다. |
|
| extend.aiTargetStructure | string | 선택적 문자열이며 저장 후 응답 표시용으로만 사용되고, 이 API는 스크립트를 생성하지 않습니다. 빈 문자열 허용: True null 허용: True 예: 얻는 방법 또는 입력 방법: AI 생성 시의 대상 구조 설명이며 필요 없으면 생략할 수 있습니다. |
|
| extend.appID | array | rum/llm은 measurement와 함께 비어 있지 않은 배열을 제공해야 합니다. 둘 다 비어 있으면 전용 소스가 없을 수 있고, appID만 있고 measurement가 없으면 파라미터 누락 오류가 발생합니다. null 허용: True 예: ["appid_example"]얻는 방법 또는 입력 방법: 해당 RUM/LLM 애플리케이션 관리에서 실제 appId를 가져옵니다. |
|
| extend.exampleSource | string | 선택적 응답 표시 값이며 source 연결을 대신하지 않습니다. 빈 문자열 허용: True null 허용: True 예: nginx얻는 방법 또는 입력 방법: 샘플 소스 표시 값이며 실제 source와 대응해야 합니다. |
|
| extend.exampleType | string | 선택적 응답 표시 문자열이며 서버에서 고정 열거형을 제공하지 않습니다. 빈 문자열 허용: True null 허용: True 예: custom얻는 방법 또는 입력 방법: 샘플 타입 표시 값이며 클라이언트 비즈니스에서 정의합니다. |
|
| extend.ifAiCreate | boolean | 선택적 응답 표시 값이며 AI 작업을 트리거하지 않습니다. null 허용: True 예: false얻는 방법 또는 입력 방법: AI 보조 생성 여부를 기록하며 이 표시가 필요 없으면 생략할 수 있습니다. |
|
| extend.loggingIndex | string | 선택적 로그 인덱스 응답 표시 필드이며 기본적으로 값을 채우지 않고, 수정 시 생략하면 extend와 함께 제거됩니다. source 배열이 아닙니다. null 허용: True 예: default얻는 방법 또는 입력 방법: 로그 인덱스 목록에서 적용 가능한 인덱스 식별자를 가져옵니다. |
|
| extend.measurement | array | rum/llm은 appID와 카테시안 조합을 만듭니다. measurement만 있고 appID가 없으면 파라미터 누락 오류가 발생하며, 저장 시 각 애플리케이션/measurement에 데이터가 실제로 있는지는 검증하지 않습니다. null 허용: True 예: ["view"]얻는 방법 또는 입력 방법: 해당 애플리케이션 실제 데이터의 measurement(예: RUM view/action 등)에서 가져오며 실제 카테고리에 따라 작성합니다. |
|
| isForce | boolean | 선택 사항이며 기본값은 false입니다. 기본값 충돌 확인에만 사용되며 구문, 소스, 이름, 버전 등의 검증을 건너뛸 수 없습니다. 강제 교체 시 기존 기본값을 비기본값으로 바꾸고 해당 버전을 아카이브합니다. null 허용: False 예: false얻는 방법 또는 입력 방법: content.confirm을 받은 후 기존 기본 Pipeline 교체를 확인했으면 true로 설정합니다. |
|
| name | string | Y | 필수이며 최대 256 계수 단위(ASCII/반각 가타카나 1, 그 외 문자 2)이고 영문자, 숫자, 밑줄, 한자 U+4e00..9fa5 및 하이픈을 허용합니다. 비어 있지 않은 값을 권장합니다. 동일 category 내에서 중복될 수 없으며 local/central이 달라도, 기존 항목이 비활성화되어 있어도 마찬가지입니다. 입력 로그 source가 아닙니다. null 허용: False 최대 길이: 256 $notSearchRegExp: [^a-zA-Z0-9_\u4e00-\u9fa5-]+ 예: production_parser얻는 방법 또는 입력 방법: 비즈니스에서 정의한 파일명이며, 먼저 Pipeline 목록에서 같은 카테고리의 삭제되지 않은 이름을 확인합니다. |
| source | array | 선택 사항이며 기본값은 []이고, 수정 시 생략하면 모든 소스 관계가 제거됩니다. * 또는 ?를 포함한 소스는 정확한 유일성 충돌 검사에 참여하지 않으며 모든 일치 항목의 런타임 동작을 보장하지 않습니다. 일반 정확 소스는 동일 category/type 내에서 다른 비삭제 Pipeline이 점유할 수 없습니다. rum/llm 추가/수정 시에는 이 배열을 무시하고 extend.appID와 measurement를 사용합니다. null 허용: False 예: ["nginx"]얻는 방법 또는 입력 방법: 해당 수집 데이터의 source 또는 소스 선택기에서 값을 가져오며 Pipeline 이름이 아닙니다. 로그는 실제 로그 source를 참고할 수 있습니다. |
|
| testData | string | 선언상 선택 사항이지만, 추가 시 생략하면 controller가 None을 디코딩해 InvalidBase64를 반환할 수 있으므로 항상 W10= 또는 빈 문자열을 명시해야 합니다. 수정 시 생략하면 빈 문자열로 복원됩니다. 공개 add/modify는 빈 문자열 또는 엄격한 base64 디코딩 결과가 비어 있거나 JSON 배열인 경우만 허용하며, 단일 객체를 직접 인코딩할 수 없습니다. 배열 멤버는 문자열 또는 객체를 권장하며, 숫자/null은 과거 항목별 길이 검사에서 500 오류를 유발할 수 있습니다. 항목당 과거 제한은 약 20480(객체는 직렬화된 객체 메모리 크기, 문자열은 과거 가중 길이)이며 스크립트 1MiB 제한과 다릅니다. 빈 문자열 허용: True null 허용: False 예: W3sibWVzc2FnZSI6ImV4YW1wbGUgbG9nIn1d얻는 방법 또는 입력 방법: 먼저 샘플 배열을 JSON으로 직렬화한 뒤 UTF8 인코딩 및 base64를 수행합니다. 빈 배열 []은 W10=입니다. |
|
| type | string | Y | 필수: local/central이며, 신서틱 테스트(dialtesting) 추가/수정은 central만 가능합니다. 워크스페이스 버전에 따라 central이 제한될 수 있습니다. 수정 시 기존 실행 유형을 교체합니다. null 허용: False 선택 가능 값: ['local', 'central'] 예: local얻는 방법 또는 입력 방법: 로컬 수집기에서 처리하면 local, 플랫폼 센터에서 처리하면 central을 선택하고 실제 데이터 진입점을 확인합니다. |
파라미터 추가 설명¶
동시 수정 보호¶
먼저 /api/v1/pipeline/<pl_uuid>/get를 호출해 현재 구성과 configVersion을 읽은 다음, 기존 수정 파라미터에 configVersion을 더해 제출할 것을 권장합니다. 이 API는 configVersion만 제출하는 부분 업데이트 API가 아니므로 name, type, category, content 등 필수 파라미터는 계약에 따라 계속 제공해야 합니다.
configVersion은 선택적 양의 정수입니다. 전달하지 않으면 이전 호출과 호환되지만 버전 번호 충돌 검사가 활성화되지 않습니다. 버전이 일치하고 구성이 실제로 변경된 경우 기존 구성을 아카이브하고 새 구성 버전을 반환합니다. 동일한 구성을 반복 저장해도 버전이 생성되지 않습니다. 409 / ft.PipelineConfigVersionConflict를 받으면 구성을 다시 읽고 비교해 확인한 후 제출해야 하며, 다른 사람의 수정을 자동으로 덮어쓸 수 없습니다.
예시 요청 본문: {"name":"demo","type":"local","category":"logging","content":"YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==","testData":"W10=","source":["nginx"],"configVersion":3}.
응답 및 재시도¶
성공 응답의 content는 현재 Pipeline 객체이며 configVersion, configVersionAt, configVersionOperator, configVersionSource, configVersionAction, configVersionSourceInfo를 포함합니다. 시간은 Unix 초 단위 타임스탬프입니다. content가 {"confirm":["logging"]}이면 기본값 교체에 확인이 필요하다는 의미이며 이번 수정은 아직 완료되지 않았습니다. isForce는 기본값 교체에만 사용되며 이름/source 또는 버전 충돌 검증을 건너뛰지 않습니다.
content와 testData 요청 필드는 모두 Base64 인코딩입니다. 일반 OpenAPI 수정은 testData 디코딩 결과가 비어 있거나 JSON 배열이어야 한다는 제약을 유지합니다. 타임아웃 후에는 먼저 현재 구성을 조회해 쓰기 결과를 확인하고 무조건 재제출하는 것을 피해야 합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/pipeline/pl_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"production_parser","type":"local","category":"logging","content":"YWRkX2tleSgiZW52IiwgInByb2R1Y3Rpb24iKQ==","testData":"W3sibWVzc2FnZSI6ImV4YW1wbGUgbG9nIn1d","dataType":"json","asDefault":0,"enableByLogBackup":0,"extend":{"loggingIndex":"default"},"source":["nginx"],"configVersion":1}'
응답¶
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 | 공용 선언입니다. |
| content.confirm | array<string> |
기본값 충돌 시 정상 엔터티를 대체하며, 교체 확인이 필요한 카테고리를 나열합니다. 이 분기에서는 이번 대상이 저장되지 않습니다. |
| content.confirm[] | string | 단일 카테고리입니다. |
| content.pl_errors | array<object> |
ft.PipelineSyntaxError 오류 content에서만 반환되는 컴파일 오류 배열입니다. |
| content.pl_errors[].error | string | 컴파일 오류 설명입니다. |
| content.pl_errors[].pos_chain | array<object> |
참조/위치 체인입니다. |
| content.pl_errors[].pos_chain[].file | string | 파일 이름입니다. |
| content.pl_errors[].pos_chain[].ln | integer | 컴파일러가 정의한 음수가 아닌 위치 인덱스이며, 문제를 조사할 때 원래 값을 유지합니다. |
| content.pl_errors[].pos_chain[].col | integer | 컴파일러가 정의한 음수가 아닌 위치 인덱스이며, 문제를 조사할 때 원래 값을 유지합니다. |
| content.pl_errors[].pos_chain[].pos | integer | 컴파일러가 정의한 음수가 아닌 위치 인덱스이며, 문제를 조사할 때 원래 값을 유지합니다. |
{
"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": 2,
"configVersionAt": 1785427200,
"configVersionOperator": "wsak_example",
"configVersionSource": "openapi",
"configVersionAction": "modify",
"configVersionSourceInfo": {},
"source": [
"nginx"
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
기본값 교체 확인 대기:
{
"code": 200,
"content": {
"confirm": [
"logging"
],
"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.InvalidBase64 | 스크립트/테스트 샘플이 디코딩 가능한 UTF8 base64가 아님, 추가 시 testData 생략으로도 발생 가능 | 유효하지 않은 base64 내용 | content와 testData를 완전히 제공하고 먼저 UTF8로 인코딩한 뒤 base64로 변환합니다. |
| 406 | ft.ContextExceedLimit | 스크립트가 UI 문자 수 또는 UTF8 바이트 1MiB를 초과하거나 add/modify 단일 테스트 샘플이 과거 길이 제한을 초과 | 텍스트 내용 초과, 제한 {}자 | 스크립트/단일 샘플을 줄이고 message에 표시된 단위를 확인합니다. |
| 406 | ft.PipelineSyntaxError | 샘플 없이 동기 컴파일한 결과 스크립트 또는 참조 구문 오류 | Pipeline 스크립트 구문 오류, 오류 위치를 확인하십시오 | content.pl_errors의 error 및 pos_chain에 따라 위치를 찾아 수정한 뒤 재시도합니다. |
| 400 | ft.PipelineNameExists | 동일 워크스페이스, 동일 category에 삭제되지 않은 동일 이름 스크립트 존재 | 동일한 이름의 Pipeline이 이미 존재합니다 | 이름을 변경하거나 기존 UUID를 업데이트합니다. |
| 400 | ft.PipelineSourceExists | 동일 category/type에 삭제되지 않은 규칙이 동일한 정확 source를 이미 점유 | 해당 타입 Pipeline의 source 출처가 이미 존재합니다 | 출처 바인딩을 확인하고 적절한 출처로 변경합니다. 와일드카드 항목은 이 검사에 참여하지 않습니다. |
| 403 | ft.ForbiddenFreeEditionWorkspace | 워크스페이스 버전의 Pipeline 실행 유형 제한이 해당 type을 허용하지 않음 | 무료 플랜 워크스페이스는 이 기능을 지원하지 않습니다. 상용 플랜을 개통하면 제한이 해제됩니다 | 관리자가 워크스페이스 버전 및 지원 실행 방식을 확인합니다. |
| 500 | ft.InternalServerError | 동기 컴파일 서비스 사용 불가/타임아웃/형식 이상(내부 PipelineValidationUnavailable이 최종적으로 통합 래핑됨), 데이터베이스, 구조 오류 또는 제출 후 포맷 실패 | 내부 오류 | 재시도 전에 현재 구성과 버전을 읽어 이미 저장되었는지 확인하고, 지속 실패 시 traceId를 제공합니다. |
| 406 | ft.DialingPipelineOnlyCentral | dialtesting에서 local 선택 | 신서틱 테스트 pipeline은 중앙 pipeline 구성만 지원합니다 | 지원되는 central로 변경하고 워크스페이스 버전을 확인합니다. |
| 406 | ft.MissingNeededParmeterAppID | rum/llm의 appID와 measurement 중 한쪽만 제공 | appID를 지정해야 합니다 | 둘 다 제공하거나 둘 다 비워 둡니다. 수정과 추가의 오류 키는 과거 호환 차이가 있습니다. |
| 404 | ft.NotFoundPipelineCfg | 이 워크스페이스의 Pipeline/이력이 없거나, 삭제되었거나, 주 구성이 삭제됨 | 지정한 Pipeline 구성을 찾을 수 없습니다 | 현재 목록/이력 목록에서 UUID를 다시 가져옵니다. |
| 409 | ft.PipelineConfigVersionConflict | 제출한 configVersion이 현재와 일치하지 않음 | Pipeline 구성이 이미 업데이트되었습니다. 새로 고친 후 재시도하십시오 | 최신 버전을 다시 가져와 변경 사항을 병합합니다. |
| 406 | ft.InvalidPipelineTestData | 공개 testData 디코딩 결과가 JSON 배열이 아님 | 유효하지 않은 pipeline testData입니다. base64 디코딩 후 비어 있거나 JSON 배열이어야 합니다 | 배열 또는 빈 문자열을 사용합니다. |