エクスポート¶
POST /api/v1/pipeline/export
概要¶
選択した Pipeline の移行テンプレート JSON をエクスポートします。
呼び出し前の確認と使用手順¶
content.pipelines 配列を返します。ファイルダウンロードではありません。現在の設定の base64 本文と examples を含み、UUID/バージョン履歴/操作者は含みません。まず現在のワークスペースの一覧で、削除されていない UUID を項目ごとに確認し、クロスワークスペース、テンプレート、その他の不一致項目を混在させないでください。主エンティティは現在のワークスペースのみを検索しますが、関連検索には入力全体を使用します。エクスポート対象に含まれない関連が含まれる場合、組み立て時に 500 になることがあります。主エンティティが 1 件もヒットしない場合は 404 を返します。混在した入力では、無効な項目だけが無視されることは保証されません。移行前に、対象のデータカテゴリ、ソース、デフォルトの競合を確認してください。インポートでは、エクスポート時の無効状態は保持されません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pipelineUUIDs[*] | string | 名前は使用しません。 例: pl_example取得または入力方法: 現在のワークスペース内の単一 UUID。 |
|
| pipelineUUIDs | array | Y | 必須配列。空でないことを推奨します。 null を許可: False 例: ["pl_example"]取得または入力方法: Pipeline 一覧 から対象の uuid を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/pipeline/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"pipelineUUIDs":["pl_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.pipelines | array<object> |
テンプレート配列。 |
| content.pipelines[].name | string | 保存設定:必須。最大 256 カウント単位(ASCII/半角カタカナは 1、その他の文字は 2)。英数字、アンダースコア、中国語 U+4e00..9fa5、およびハイフンを使用できます。空でないことを推奨します。同じ category では、local/central が異なる場合や古い項目が無効な場合でも重複できません。入力ログの source ではありません。 |
| content.pipelines[].type | string | 保存設定:必須。local/central。Synthetic テスト(dialtesting)の新規作成/変更は central のみです。ワークスペースのバージョンによっては central が制限される場合があります。変更すると元の実行タイプが置き換えられます。 |
| content.pipelines[].category | string | 保存設定:必須。lineage/logging/object/custom_object/network/tracing/rum/llm/agent_monitor/security/keyevent/metric/profiling/dialtesting/cloud_billing。billing は従来互換の値です。変更時にカテゴリを変更できますが、スクリプト、source、extend を併せて確認する必要があります。 |
| content.pipelines[].source | array | 保存設定:任意、デフォルト []。変更時に省略すると、すべてのソース関連が削除されます。* または ? を含むソースは、完全一致の一意性競合チェックの対象外で、一致するすべての実行時動作は保証されません。通常の完全一致ソースは、同じ category/type 内で、削除されていない他の Pipeline によって占有されることはありません。rum/llm の新規作成/変更ではこの配列は無視され、extend.appID と measurement が使用されます。 |
| content.pipelines[].source[] | string | 保存設定:空でない文字列を推奨します。配列は項目ごとに厳密検証されません。関連のないデータドメインを混在させないでください。 |
| content.pipelines[].content | string | 保存設定:必須の base64 文字列。新規作成時はデコード後に空でない必要があります。デコード後のスクリプト全文は、UI の文字カウント ≤1048576 かつ UTF8 バイト数 ≤1048576 の両方を満たす必要があります。BMP の非 ASCII は 2、補助文字は 4 としてカウントされます。いずれかが上限を超えると ft.ContextExceedLimit になります。保存時にはサンプルなしのコンパイルを同期実行し、同じカテゴリで有効なスクリプト参照を確認します。成功しても、実データでのデバッグ通過や有効化を意味するものではありません。 |
| content.pipelines[].dataType | string | 保存設定:任意、デフォルト line_protocol。line_protocol/json/message をサポートします。変更時に省略すると line_protocol に戻ります。category ではありません。空文字列は互換として宣言されていますが、サポートされる値を明示的に選択してください。 |
| content.pipelines[].asDefault | integer | 保存設定:任意、デフォルト 0。0/1 のみを指定することを推奨します。既にデフォルトが存在し、isForce でない場合は HTTP 200 で confirm 配列が返され、今回の対象設定は保存されません。作成/変更の成功として扱わないでください。 |
| content.pipelines[].enableByLogBackup | integer | 保存設定:任意、デフォルト 0。0/1 を推奨します。このフラグを保存しても、既存の転送データが自動的に再実行されることは保証されません。 |
| content.pipelines[].extend | json | 保存設定:任意、デフォルト {}。変更時は全体を置き換え、マージしません。rum/llm は appID×measurement の組み合わせでソース関連を生成します。未知のサブフィールドは公開バリデーションで拒否されます。 |
| content.pipelines[].extend.appID | array | 保存設定:rum/llm では measurement と同時に空でない配列を指定する必要があります。両方とも空の場合は専用ソースなしにできます。appID があり measurement がない場合はパラメータ不足エラーになります。 |
| content.pipelines[].extend.measurement | array | 保存設定:rum/llm では appID と直積の組み合わせになります。measurement があり appID がない場合はパラメータ不足エラーになります。保存時に各アプリ/measurement にデータが存在するかは検証されません。 |
| content.pipelines[].extend.loggingIndex | string | 保存設定:任意のログインデックス返却フィールド。デフォルトでは値を補完しません。変更時に省略すると extend とともにクリアされます。source 配列ではありません。 |
| content.pipelines[].extend.ifAiCreate | boolean | 保存設定:任意の返却項目。AI タスクはトリガーしません。 |
| content.pipelines[].extend.aiTargetStructure | string | 保存設定:任意の文字列。保存と返却のみを行い、この API はスクリプトを生成しません。 |
| content.pipelines[].extend.exampleSource | string | 保存設定:任意の返却項目。source 関連の代わりにはなりません。 |
| content.pipelines[].extend.exampleType | string | 保存設定:任意の返却文字列。サーバー側で固定の列挙型は提供されません。 |
| content.pipelines[].extend.appID[] | string | 保存設定:空でない文字列を推奨します。 |
| content.pipelines[].extend.measurement[] | string | 保存設定:空でない文字列を推奨します。 |
| content.pipelines[].isDisable | boolean | エクスポート時の元の状態。現在の公開 import ではこのフラグは適用されず、インポート後はデフォルトで有効になります。 |
| content.pipelines[].examples | array<object> |
テストサンプル配列。各項目は個別に base64 です。 |
| content.pipelines[].examples[] | object | 単一サンプル。 |
| content.pipelines[].examples[].data | string | 単一サンプルの UTF8 文字列の base64。オブジェクトは JSON としてエンコードし、テキストはインポート時の解析で失われないよう JSON 文字列としてエンコードします。 |
| content.declaration | object | 共通宣言。インポートでは pipelines のみを取得します。 |
{
"code": 200,
"content": {
"pipelines": [
{
"name": "production_parser",
"type": "local",
"category": "logging",
"asDefault": 0,
"enableByLogBackup": 0,
"source": [
"nginx"
],
"isDisable": false,
"content": "YWRkX2tleSgiZW52IiwgInByb2R1Y3Rpb24iKQ==",
"examples": [
{
"data": "eyJtZXNzYWdlIjoiZXhhbXBsZSBsb2cifQ=="
}
],
"dataType": "json",
"extend": {
"loggingIndex": "default"
}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 406 | ft.PipelineNotExist | リクエストされたコレクションに、現在のワークスペース内で削除されていないヒット項目が 1 件もない | エクスポート対象の Pipeline が存在しない | 一覧を更新してから再度エクスポートしてください。 |
| 500 | ft.InternalServerError | 入力に、エクスポート対象に含まれない関連 UUID が混在している、または設定/サンプルの組み立てに失敗した | 内部エラー | 現在のワークスペース一覧で項目ごとに確認した削除されていない UUID のみを使用してエクスポートしてください。失敗が続く場合は traceId を提供してください。 |