一覧¶
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。Synthetic テスト(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 | 設定保存: オプション。デフォルトは []。変更時に省略するとすべてのソース関係が削除されます。* または ? を含む source は正確な一意性競合チェックの対象外となり、すべてのマッチングの実行時動作は保証されません。通常の正確な source は、同じ 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 | 設定保存: オプションの文字列。保存と表示のみ。本 API はスクリプトを生成しません。 |
| 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 を提供してください。 |