インデックスを削除¶
POST /api/v1/log_index_cfg/delete
概要¶
指定したログインデックスを削除し、ソースとクローンの関係を処理します。
呼び出し前の準備と使用手順¶
削除処理は実際のストレージ削除インターフェースまたは外部インデックス削除通知を呼び出し、その後、設定とフィールドマッピングをソフト削除します。ソース A を削除し deleteCloneIndex=false の場合、B は UUID、名前、自身の設定を保持して通常インデックスに昇格し、A/B の条件は詳細条件に変換された後 AND でマージされます。状態は A/B の元の有効/無効状態を総合して決定され、元のマッチング範囲が変わらないことは保証されません。deleteCloneIndex=true の場合はカスケードで先に B を削除してから A を削除し、いずれかのステップが失敗すると直ちに停止します。B を直接削除する場合、または B が存在しない場合は対象のみを処理します。
デフォルトインデックスはサポートされません。現在のワークスペースで元の UUID がすでに削除されている場合は冪等に成功し、後から同名で作成された新しいインデックスを名前で削除することはありません。成功時は content=true となり、内部の昇格/削除のサマリーは返されません。リスト/詳細で確認してください。失敗時、ft.LogIndexDeleteFailed の content には完了済みオブジェクトと失敗ステージが含まれます。ストレージは削除済みだが設定に失敗した場合は元の UUID でリトライし、configurationState=unknown の場合はまず設定を確認してください。部分的に成功した完了済みオブジェクトも監査に記録されます。
リクエストヘッダ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfgUUID | string | Y | 必須。このワークスペースの設定 UUID であり、名前ではなく、default は指定できません。 null 許容: False 例: lgim_example取得または入力方法: ログインデックスリストから対象の uuid をコピーします。 |
| deleteCloneIndex | boolean | 任意。デフォルトは false。JSON のブール値のみ。削除操作は名前でリトライできません。 null 許容: False 例: false取得または入力方法: ソース A とそのクローン B を同時に削除する場合は true、B を保持して昇格する場合は false。 |
パラメータの補足説明¶
A/B のマッチング条件は詳細条件に変換され、AND で B にマージされます。B は UUID、名前、自身の設定を保持し、ソース関係はクリアされます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"cfgUUID":"lgim_example","deleteCloneIndex":false}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | すべて完了した場合、または現在のワークスペースで元の UUID が削除済みで冪等に成功した場合は true。内部の promotedClone サマリーは返されません。 |
| エラー content.deletedIndexes | array<object> |
ストレージと設定の両方が完了したオブジェクトのみを含みます。 |
| エラー content.deletedIndexes[].uuid | string | 完了した設定 UUID。 |
| エラー content.deletedIndexes[].name | string | 完了したインデックス名。 |
| エラー content.failedIndex | object | 今回失敗したオブジェクト。 |
| エラー content.failedIndex.uuid | string | 失敗した UUID。 |
| エラー content.failedIndex.name | string | 失敗したインデックス名。 |
| エラー content.failureStage | string | storage/configuration。 |
| エラー content.storageDeleted | boolean | 今回の対象ストレージ削除が完了したことを示すフラグ。 |
| エラー content.retryable | boolean | true の場合、確認後に元の UUID でリトライできます。 |
| エラー content.configurationState | string | not_attempted/not_committed/unknown。unknown の場合は完全な設定を確認する必要があり、status のみから推測することはできません。 |
| エラー content.reason | string | 該当ステージの説明(中国語)。 |
| エラー content.causeErrorCode | string | 上流 APIException の元の code、または空文字列。特定の補助情報であり、トップレベルのエラーとは同一ではありません。 |
{
"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 ファイルの形式エラー | パラメータ表に従ってオブジェクトを送信し、storagePolicy には JSON オブジェクトを使用してください。 |
| 400 | ft.DefaultIndexUnsupportAction | 対象が default | デフォルトインデックスはこの操作をサポートしていません | デフォルトインデックスは削除できません。 |
| 404 | ft.LogIndexCfgNoExists | このワークスペースに該当 UUID の現在または削除済みの設定が存在しない | 指定されたログインデックス設定が存在しません | リストから有効な対象を確認してください。 |
| 400 | ft.LogIndexCloneRelationInvalid | A/B 関係が無効、または同時変更が発生 | ログインデックスのクローン関係が無効 | 関係を再読み取りしてから元の UUID で操作してください。 |
| 429 | ft.OperationTooFrequently | 関係ロックが占有されている、または失効している | 操作が頻繁すぎます。しばらくしてから再試行してください | バックオフして現在の関係を確認してください。 |
| 400 | ft.LogIndexDeleteFailed | ストレージまたは設定ステージが未完了(部分成功を含む) | ログインデックスの削除が完了していません。再試行してください | エラーの content に従って completed/failed オブジェクトとステージを確認し、failedIndex.uuid を使用してリトライし、traceId を保持してください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、下流接続/通常の 5xx、またはフィールド形状の異常 | 内部エラー | まず設定を読み取り、実際のストレージの現状を確認してください。失敗が継続する場合は traceId を提供してください。エラーを未保存や直接重複追加可能とみなさないでください。 |
| 403 | ft.Forbidden | 権限不足、または現在のバージョンでこのインターフェースが許可されていない | 操作権限がありません | 対応するインデックス権限を持つ API Key とサポート対象バージョンを使用してください。 |