削除¶
GET /api/v1/pipeline/delete
概要¶
Pipeline およびそのソースとの関連付けを一括でソフト削除します。
呼び出し前の準備と使用手順¶
パラメータは URL Query にあり、本ワークスペースのリストから項目ごとに確認したうえで、有効な UUID を半角カンマで連結する必要があります。他のワークスペース、システムテンプレート、その他の一致しない識別子を混在させないでください。本ワークスペースの主設定に少なくとも 1 件一致した後、関連付けの削除は入力された UUID 全体でクエリされます。主オブジェクトに一致しなかった場合でも、その関連付けが必ず影響を受けていないと解釈することはできません。現在の設定と、クエリで見つかった対応する関連付けをソフト削除しますが、すでに処理されたデータは削除せず、すべての履歴ストレージも直ちには削除しません。主設定を削除すると、履歴の読み取り/復元も利用できなくなります。空値や未知の UUID でも成功 true を返す場合があるため、レスポンスで削除数を集計することはできません。
これは従来の GET 削除インターフェースです。呼び出すと設定が変更されるため、副作用のないクエリや自動プリフェッチ用のリンクとして使用することはできません。呼び出す前に設定のバックアップを保存し、削除範囲を明確にしてください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pipelineUUIDs | commaArray | Y | 必須のカンマ区切り文字列であり、Body の配列ではありません。空でないことを推奨します。一致しない場合も 404 は返しません。 null を許可: False 例: pl_example取得または入力方法: Pipeline 一覧 から uuid を取得し、複数の場合は半角カンマで連結します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/pipeline/delete?pipelineUUIDs=pl_example' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true で、削除数ではありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータの解析に失敗 | Query パラメータの表と例を確認してください。 |
| 500 | ft.InternalServerError | データベースアクセス、コミット、または履歴データ構造の異常 | 内部エラー | まずリストと詳細で対象設定の削除状態を読み戻し、すでに反映されているかを確認してから再試行を判断してください。継続的に失敗する場合は traceId を提供してください。 |