コンテンツにスキップ

取得



GET /api/v1/pipeline/{pl_uuid}/get

概要

Pipeline スクリプト、サンプル、バージョン、および保存済みの完全な設定を読み取ります。

呼び出し前の準備と使用手順

一覧から uuid を取得します。本ワークスペースの未削除の設定を読み取ることができ、UUID が既知の公共システムテンプレート(workspaceUUID が空文字列)も読み取れます。ただし、システムテンプレートは直接変更できることを意味しません。content/testData は引き続き base64 であるため、呼び出し側で UTF-8 にデコードして編集した後、再度エンコードして送信します。rum/llm の詳細では source が [] となるため、extend.appID/measurement を使用して構造化されたバインディングを確認します。システムテンプレートの source にはテンプレート名が入ります。

ルートパラメータ

パラメータ名 型 必須 説明
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 を取得します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/pipeline/pl_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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。Synthetic テスト 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 と UTF-8 バイト数 ≤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 共通宣言。
{
  "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": 1,
    "configVersionAt": 1785427200,
    "configVersionOperator": "wsak_example",
    "configVersionSource": "openapi",
    "configVersionAction": "create",
    "configVersionSourceInfo": {},
    "source": [
      "nginx"
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.NotFoundPipelineCfg 本ワークスペースの Pipeline/履歴が存在しない、削除済み、またはそのメイン設定が削除済み 指定された Pipeline 設定が見つかりません 現在の一覧/履歴一覧から UUID を再取得してください。
500 ft.InternalServerError 設定の読み取り、識別情報、またはレスポンスのエンコードに失敗 内部エラー UUID と保存済みデータを確認し、しばらくしてから再試行してください。継続的に失敗する場合は traceId を提供してください。

フィードバック

このページは役に立ちましたか?