수정¶
POST /api/v1/pipeline/{pl_uuid}/modify
개요¶
Pipeline 수정
category가 profiling인 경우, 워크스페이스에 설정된 CentralPLServiceSwitch(/workspace/get 인터페이스 반환) 필드가 true일 때만 이 규칙이 실제로 적용됩니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pl_uuid | string | Y | Pipeline의 ID |
본문 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | Y | Pipeline 파일 이름이자 source 유형 값 비어 있음 허용: False 최대 길이: 256 $notSearchRegExp: [^a-zA-Z0-9_\u4e00-\u9fa5-]+ |
| type | string | Y | Pipeline 파일 유형 비어 있음 허용: False 선택 가능 값: ['local', 'central'] |
| source | array | 선택한 source 목록 비어 있음 허용: False |
|
| content | string | Y | pipeline 파일 내용(base64 인코딩). |
| base64 디코딩된 스크립트는 Studio UI의 문자 수 계산 규칙에 따라 검증됩니다. U+0001–U+007E, U+FF60–U+FF9F는 1자, 기타 UTF-16 단위는 2자로 계산하며, 상한은 10240입니다. | |||
비어 있음 허용: False |
|||
| testData | string | 테스트 데이터(base64 인코딩). OpenAPI 측에서는 빈 문자열 또는 base64 디코딩 후 JSON 배열인 내용만 허용합니다. |
생성 방식: 1. 먼저 테스트 샘플 배열을 준비합니다. 2. 배열에 대해 JSON.stringify를 실행합니다. 3. 생성된 UTF-8 문자열을 base64 인코딩하여 testData에 전달합니다.
일반적인 예시: - 빈 샘플 배열: [] -> W10= - 단일 JSON 로그: [{"level":"info","msg":"HTTP"}] -> W3sibGV2ZWwiOiJpbmZvIiwibXNnIjoiSFRUUCJ9XQ== - 단일 텍스트 로그: ["raw log line"] -> WyJyYXcgbG9nIGxpbmUiXQ==
잘못된 예시: {"level":"info","msg":"HTTP"}를 직접 base64 인코딩하여 전달하는 경우, 디코딩 후 최상위가 object이므로 배열이 아닙니다.
비어 있음 허용: False
빈 문자열 허용: True
|
| dataType | string | | 데이터 유형: line_protocol-행 프로토콜 형식; json-JSON 형식; message-Message
예시: line_protocol
비어 있음 허용: False
빈 문자열 허용: True
선택 가능 값: ['line_protocol', 'json', 'message']
|
| isForce | boolean | | 특정 유형에 default가 있는 경우, 대체 여부
비어 있음 허용: False
|
| asDefault | int | | 해당 유형의 기본 Pipeline으로 설정할지 여부, 1은 기본으로 설정
비어 있음 허용: False
|
| enableByLogBackup | int | | Pipeline이 전달 데이터를 처리하도록 활성화, 1은 활성화, 0은 비활성화
비어 있음 허용: False
|
| category | string | Y | 카테고리
비어 있음 허용: False
빈 문자열 허용: False
선택 가능 값: ['logging', 'object', 'custom_object', 'network', 'tracing', 'rum', 'llm', 'agent_monitor', 'security', 'keyevent', 'metric', 'profiling', 'dialtesting', 'billing', 'keyevent']
|
| extend | json | | 카테고리
비어 있음 허용: False
|
| extend.appID | array | | appID
비어 있음 허용: True
|
| extend.measurement | array | | source 출처
비어 있음 허용: True
|
| extend.loggingIndex | string | | 로그 인덱스
비어 있음 허용: True
|
매개변수 추가 설명¶
요청 예시¶
curl 'https://openapi.guance.com/api/v1/pipeline/pl_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"test_modify","category":"logging","asDefault":0,"content":"YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==","testData":"W3sibGV2ZWwiOiJpbmZvIiwibXNnIjoiSFRUUCJ9XQ==","source":["nsqlookupd"]}' \
--compressed
응답¶
{
"code": 200,
"content": {
"asDefault": 0,
"category": "logging",
"content": "YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==\n",
"createAt": 1678026470,
"creator": "xxx",
"deleteAt": -1,
"extend": {},
"id": 86,
"isSysTemplate": 0,
"name": "test_modify",
"source": [],
"status": 0,
"testData": "W10=\n",
"updateAt": 1678026808.95266,
"updator": "xx",
"uuid": "pl_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-1EA80DD4-EB2C-4A9B-A146-D00606CC50E0"
}