콘텐츠로 이동

목록



GET /api/v1/pipeline/list

개요

현재 워크스페이스의 Pipeline 요약, 소스 및 활성화/비활성화 설정을 나열합니다.

호출 전 및 사용 단계

페이지네이션하지 않으며, 기본 규칙에 따라 앞에 배치하고 레코드 id 내림차순으로 삭제되지 않은 모든 항목을 반환하며 비활성화된 항목도 포함합니다. 현재 공개 Query는 isSysTemplate를 선언하지 않으므로 시스템 템플릿 목록을 직접 전환하는 것은 지원하지 않습니다. content/testData 또는 configVersion은 반환하지 않으며, 편집 전에 상세 정보를 다시 읽어야 합니다.

요청 헤더

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

Query 요청 파라미터

파라미터명 타입 필수 설명
categories commaArray 선택 사항, 제공하지 않으면 이 워크스페이스의 모든 카테고리를 조회합니다. JSON 배열이 아닙니다.
null 허용: False
예: logging,metric
획득 또는 입력 방법: category 선택을 지원하며, 여러 개일 경우 영문 쉼표로 구분합니다.
search string 선택 사항, 앞뒤 공백을 제거한 후 이름 리터럴 포함 매칭하며, %/_는 리터럴로 처리하고 source로는 검색하지 않습니다.
null 허용: False
예: production
획득 또는 입력 방법: Pipeline 파일명 키워드입니다.
type string 선택 사항, 실행 방식 필터이며 제공하지 않으면 두 가지 모두 조회합니다.
null 허용: False
선택 가능 값: ['local', 'central']
예: local
획득 또는 입력 방법: local 또는 central입니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/pipeline/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode categories=logging \
  --data-urlencode type=local

응답

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

필드 타입 설명
content.data array<object> 규칙 요약 배열이며, 빈 결과는 []입니다.
content.data[].uuid string pl_ 객체 UUID입니다.
content.data[].status integer 0 활성화, 2 비활성화, 3 삭제입니다.
content.data[].creator string 생성 주체입니다.
content.data[].updator string 최근 업데이트 주체입니다.
content.data[].createAt integer 생성 Unix 초입니다.
content.data[].updateAt integer 업데이트 Unix 초입니다.
content.data[].name string 저장 설정: 필수, 최대 256 계수 단위(ASCII/반각 가타카나 1, 기타 문자 2), 영문자/숫자/밑줄/중국어 U+4e00..9fa5 및 하이픈 허용; 비어 있지 않을 것을 권장합니다. 동일 category에서는 local/central이 다르거나 기존 항목이 비활성화되어 있어도 중복을 허용하지 않습니다. 입력 로그 source가 아닙니다.
content.data[].type string 저장 설정: 필수 local/central; 신서틱 테스트(dialtesting) 신규 추가/수정은 central만 가능합니다. 워크스페이스 버전에 따라 central이 제한될 수 있습니다. 수정 시 기존 실행 유형이 대체됩니다.
content.data[].category string 저장 설정: 필수 lineage/logging/object/custom_object/network/tracing/rum/llm/agent_monitor/security/keyevent/metric/profiling/dialtesting/cloud_billing; billing은 과거 호환 값입니다. 수정 시 카테고리를 변경할 수 있으며, 스크립트, source 및 extend를 함께 확인해야 합니다.
content.data[].source array 저장 설정: 선택 사항, 기본값 []; 수정 시 생략하면 모든 소스 관계가 제거됩니다. * 또는 ?를 포함한 소스는 정확한 고유성 충돌 검사에 참여하지 않으며 모든 매칭 런타임 동작을 보장하지 않습니다. 일반 정확한 소스는 동일 category/type 내에서 다른 비삭제 Pipeline이 점유할 수 없습니다. rum/llm 신규 추가 및 수정 시 이 배열은 무시되고 extend.appID와 measurement를 사용합니다.
content.data[].source[] string 저장 설정: 비어 있지 않은 문자열을 권장하며, 배열은 항목별로 엄격하게 검증되지 않습니다. 관련 없는 데이터 영역을 혼합하지 마십시오.
content.data[].dataType string 저장 설정: 선택 사항, 기본값 line_protocol; line_protocol/json/message를 지원합니다. 수정 시 생략하면 line_protocol로 복원됩니다. category가 아닙니다. 빈 문자열은 호환된다고 선언되어 있으나 지원되는 값을 명확히 선택해야 합니다.
content.data[].asDefault integer 저장 설정: 선택 사항, 기본값 0, 0/1만 지정할 것을 권장합니다. 이미 기본값이 있고 isForce가 아닌 경우 HTTP 200과 함께 confirm 배열이 반환되며, 이번 대상 설정은 저장되지 않으므로 생성/수정 성공으로 간주하지 않습니다.
content.data[].enableByLogBackup integer 저장 설정: 선택 사항, 기본값 0, 0/1을 권장합니다. 저장 플래그가 기존 전송 데이터의 자동 재실행을 보장하지 않습니다.
content.data[].extend json 저장 설정: 선택 사항, 기본값 {}; 수정 시 전체가 대체되며 병합되지 않습니다. rum/llm은 appID×measurement 조합으로 소스 관계를 생성합니다. 알 수 없는 하위 필드는 공개 검증에서 거부됩니다.
content.data[].extend.appID array 저장 설정: rum/llm은 measurement와 함께 비어 있지 않은 배열을 제공해야 합니다. 둘 다 비어 있으면 전용 소스가 없을 수 있고, appID가 있고 measurement가 없으면 파라미터 누락 오류가 발생합니다.
content.data[].extend.measurement array 저장 설정: rum/llm은 appID와 카티션 조합을 만듭니다. measurement가 있고 appID가 없으면 파라미터 누락 오류가 발생하며, 저장 시 각 애플리케이션/measurement에 실제 데이터가 있는지 검증하지 않습니다.
content.data[].extend.loggingIndex string 저장 설정: 선택 사항인 로그 인덱스 에코 필드, 기본적으로 값을 채우지 않으며, 수정 시 생략하면 extend와 함께 제거됩니다. source 배열이 아닙니다.
content.data[].extend.ifAiCreate boolean 저장 설정: 선택 사항 에코, AI 작업을 트리거하지 않습니다.
content.data[].extend.aiTargetStructure string 저장 설정: 선택 사항 문자열, 저장 및 에코만 하며 이 인터페이스는 스크립트를 생성하지 않습니다.
content.data[].extend.exampleSource string 저장 설정: 선택 사항 에코, source 연결을 대체하지 않습니다.
content.data[].extend.exampleType string 저장 설정: 선택 사항 에코 문자열, 서버에서 고정 열거형을 제공하지 않습니다.
content.data[].extend.appID[] string 저장 설정: 비어 있지 않은 문자열을 권장합니다.
content.data[].extend.measurement[] string 저장 설정: 비어 있지 않은 문자열을 권장합니다.
content.data[].creatorInfo object 신원 요약이며, 파싱할 수 없으면 {}입니다.
content.data[].creatorInfo.uuid string 신원 UUID, 생략 가능합니다.
content.data[].creatorInfo.status integer 계정 상태, 생략 가능합니다.
content.data[].creatorInfo.wsAccountStatus integer 멤버 관계 상태, 생략 가능합니다.
content.data[].creatorInfo.name string 표시 이름입니다.
content.data[].creatorInfo.username string 로그인 이름입니다.
content.data[].creatorInfo.email string 이메일 또는 시스템 신원 식별자입니다.
content.data[].creatorInfo.mobile string 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].creatorInfo.countryCode string 국가/지역 코드, 생략 가능합니다.
content.data[].creatorInfo.iconUrl string 아바타입니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임, 생략 가능합니다.
content.data[].updatorInfo object 신원 요약이며, 파싱할 수 없으면 {}입니다.
content.data[].updatorInfo.uuid string 신원 UUID, 생략 가능합니다.
content.data[].updatorInfo.status integer 계정 상태, 생략 가능합니다.
content.data[].updatorInfo.wsAccountStatus integer 멤버 관계 상태, 생략 가능합니다.
content.data[].updatorInfo.name string 표시 이름입니다.
content.data[].updatorInfo.username string 로그인 이름입니다.
content.data[].updatorInfo.email string 이메일 또는 시스템 신원 식별자입니다.
content.data[].updatorInfo.mobile string 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].updatorInfo.countryCode string 국가/지역 코드, 생략 가능합니다.
content.data[].updatorInfo.iconUrl string 아바타입니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임, 생략 가능합니다.
content.declaration object 공통 선언입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "uuid": "pl_example",
        "name": "production_parser",
        "type": "local",
        "category": "logging",
        "dataType": "json",
        "asDefault": 0,
        "enableByLogBackup": 0,
        "extend": {
          "loggingIndex": "default"
        },
        "status": 0,
        "creator": "wsak_example",
        "updator": "wsak_example",
        "createAt": 1785427200,
        "updateAt": 1785427200,
        "source": [
          "nginx"
        ],
        "creatorInfo": {},
        "updatorInfo": {}
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인하십시오.
500 ft.InternalServerError 설정 읽기, 신원 정보 또는 응답 인코딩 실패 내부 오류 UUID와 저장된 데이터를 확인하고 잠시 후 다시 시도하십시오. 지속적으로 실패하면 traceId를 제공하십시오.

문서 평가

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