버전 기록 상세¶

GET /api/v1/pipeline_history/{pipeline_history_uuid}/get

개요¶

선택한 기록 구성과 beforePipelineHistoryInfo를 반환하며, 호출 측은 두 스냅샷을 사용하여 차이를 계산합니다.

경로 파라미터¶

파라미터 추가 설명¶

지정된 기록 버전의 전체 구성과 바로 이전 버전을 읽어 호출 측이 차이를 계산할 수 있게 합니다. 이 인터페이스는 Pipeline을 수정하지 않으며 스크립트도 실행하지 않습니다.

호출 및 반환¶

먼저 기록 목록 historyRecord[].uuid에서 pipeline_history_uuid를 가져옵니다. Pipeline UUID, 기록 숫자 id 또는 버전 번호를 사용하지 않습니다.

content는 선택된 기록이며, content.config는 해당 기록의 전체 구성입니다. content.beforePipelineHistoryInfo는 동일한 Pipeline에서 버전 번호가 더 작으면서 가장 최근에 사용 가능한 기록이며, 사용 가능한 이전 버전이 없으면 {}를 반환합니다. 기록 정리 후에는 모든 중간 버전이 연속적으로 존재한다는 보장이 없습니다. 이 인터페이스는 텍스트 diff를 직접 반환하지 않으며 임의의 두 버전 번호를 전달하는 것도 지원하지 않습니다. 임의의 두 버전을 비교해야 하는 경우 두 기록 UUID의 config를 각각 읽어 직접 비교하세요.

사용 전제 조건¶

소속 워크스페이스의 DF-API-KEY로 OpenAPI 서비스를 호출합니다. 조회에는 읽기 권한이 필요하며, 복원 및 복제에는 Pipeline 관리 및 쓰기 권한이 필요합니다. 인터페이스는 요청 본문을 통해 다른 워크스페이스나 작업자를 지정하는 것을 지원하지 않습니다. 예시의 Endpoint, 리소스 UUID 및 API-Key는 모두 자리 표시자이므로 교체한 후 호출하고 API Key를 로그에 출력하지 마세요.

응답 예시는 가상의 리소스를 사용하여 일반적인 비즈니스 필드를 보여줍니다. 실제 응답에는 일반 Pipeline 인터페이스의 다른 필드가 포함될 수 있습니다. 호출 측은 새로 추가된 필드를 호환해야 합니다.

버전 필드¶

기록의 config.content 및 config.testData는 Base64 인코딩 문자열입니다. 호출 측은 먼저 Base64로 디코딩한 다음 UTF-8로 읽습니다. testData는 테스트 샘플이며, 읽기 또는 복원 인터페이스를 통해 자동으로 실행되지 않습니다. configVersionSourceInfo의 출처 버전 번호를 현재 버전 번호로 간주하지 마세요.

예외 처리¶

기록이 정리되었거나, 소속 Pipeline이 삭제되었거나, 현재 워크스페이스에 속하지 않는 경우 리소스에 접근할 수 없다는 오류를 반환합니다. 목록 보존 기간을 벗어난 기록 UUID가 장기간 사용 가능할 것이라고 의존하지 마세요.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/pipeline_history/<pipeline_history_uuid>/get' -H 'DF-API-KEY: <API-Key>'

응답¶

{
    "code": 200,
    "content": {
        "id": 101,
        "uuid": "plh_example",
        "pipelineUUID": "pl_example",
        "configVersion": 2,
        "configVersionAt": 1788800000,
        "configVersionOperator": "acnt_example",
        "configVersionOperatorInfo": {},
        "configVersionSource": "openapi",
        "configVersionAction": "modify",
        "configVersionSourceInfo": {},
        "createAt": 1788800100,
        "config": {
            "name": "demo",
            "type": "local",
            "category": "logging",
            "source": [
                "nginx"
            ],
            "content": "YWRkX2tleShjaXR5LCAic2hhbmdoYWkiKQ==",
            "testData": "W10=",
            "dataType": "line_protocol",
            "asDefault": 0,
            "enableByLogBackup": 0,
            "extend": {}
        },
        "beforePipelineHistoryInfo": {}
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE_EXAMPLE"
}