削除¶
POST /api/v1/log_backup_cfg/batch_delete
概要¶
データ転送ルールと関連するアクセス設定を一括削除します。
呼び出し前の注意事項と使用手順¶
このワークスペース内で削除されておらず、deleting 中でもない一致する UUID のみを処理します。一致しない項目、空の配列、または削除済みの項目でも true を返す場合があり、項目ごとの一致件数は返しません。Iceberg の除外項目に一致した場合、書き込み前に処理全体が Forbidden になります。他の入口で管理されているルールを混在させないでください。
guanceObject の組み込みストレージルールは、先に status=2 および deleteStatus=deleting を設定し、バックグラウンドでの削除完了を待ちます。外部ターゲットルールは直接ソフト削除されます。一致したルールに関連するアクセス設定も削除済みとしてマークされます。この操作では、このコントローラーから顧客の外部バケット、Kafka クラスター、Doris テーブル、サービスインデックスを直接削除することはありません。組み込みデータの削除結果は後で確認する必要があります。成功時の true は、すべてのデータが即時にクリーンアップされたことを意味しません。削除中のルールは詳細/クエリタスクで使用できません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfgUUIDs[*] | string | 文字列 UUID。サーバーは自動的に空白を除去しません。 例: lgbp_example取得・入力方法: データ転送ルール一覧から単一ルールの uuid を取得します。 |
|
| cfgUUIDs | array | Y | 必須の UUID 配列です。ルール名やカンマ区切り文字列ではありません。 null を許可: False 例: ["lgbp_example"]取得・入力方法: データ転送ルール一覧から対象の uuid を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_backup_cfg/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"cfgUUIDs":["lgbp_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | リクエストが処理された場合に true。実際の一致件数や物理削除の完了を示すマークではありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | パラメータ表の JSON オブジェクトを送信してください。 |
| 403 | ft.Forbidden | 現在の OpenAPI で除外されている Iceberg 設定に一致した、またはインターフェースの権限が不足している | 操作権限がありません | この公開リストでサポートされている対象のみを操作してください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、フィールド形状、または一般的なダウンストリームの 5xx/タイムアウト処理に失敗 | 内部エラー | 書き込み後はまずルールの現在の状態を確認し、クエリタスクでは先に task_id を確認してください。継続的に失敗する場合は traceId を提供してください。 |