バージョン履歴の詳細¶

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

概要¶

選択した履歴設定とbeforePipelineHistoryInfoを返します。呼び出し元は2つのスナップショットを使用して差分を計算します。

ルートパラメータ¶

パラメータの補足説明¶

指定した履歴バージョンの完全な設定と、その直前のより古いバージョンを読み取り、呼び出し元が差分を計算できるようにします。このインターフェースは Pipeline を変更せず、スクリプトも実行しません。

呼び出しと戻り値¶

まず履歴リストの historyRecord[].uuid から pipeline_history_uuid を取得してください。Pipeline UUID、履歴の数値 ID、バージョン番号は使用しないでください。

content は選択した履歴レコードであり、content.config がその完全な設定です。content.beforePipelineHistoryInfo は、同じ Pipeline のバージョン番号がより小さく、かつ直近で利用可能な履歴レコードです。利用可能な直前バージョンがない場合は {} を返します。履歴のクリーンアップ後、すべての途中バージョンが連続して存在することは保証されません。このインターフェースはテキスト diff を直接返さず、任意の2つのバージョン番号を渡すこともサポートしません。任意の2バージョンを比較する必要がある場合は、それぞれの履歴 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"
}