インデックス設定の有効化/無効化¶
POST /api/v1/log_index_cfg/{cfg_uuid}/set_disable
概要¶
単一の非デフォルトログインデックス設定を有効化または無効化します。
呼び出し前と使用手順¶
リストからインデックス UUID を選択します。true の場合は status=2、false の場合は 0 を設定します。API 宣言では null を許可していますが、現在の実装では偽値として扱われ、有効化されます。呼び出し元は明確なブール値のみを送信してください。デフォルトの default はサポートされません。存在しない/削除済みの場合は 404 を返します。
クローン B は独立して有効化/無効化できます。B 自体が有効であっても、ソース A が無効な場合は現在有効な振り分け先として扱うべきではありません。ソースの状態と併せて確認する必要があります。状態の保存後にキャッシュをクリアしますが、既存のログは削除しません。すべての下流の読み取り/書き込みが即時に切り替わることは保証されません。ソース/クローン関係が同時に変更された場合は、更新してから再試行してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfg_uuid | string | Y | パス設定 UUID。インデックス名ではありません。デフォルトインデックスは一部の変更操作のみ可能です。使用方法を参照してください。 例: lgim_example取得または入力方法: ログインデックス一覧 の content.data[].uuid から本ワークスペースの設定を取得します。デフォルトインデックスは default を使用します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isDisable | boolean | Y | 必須。JSON のブール値を推奨します。宣言では null を許可していますが、現在 null は有効化として処理されます。 null を許可: True 例: true取得または入力方法: true で無効化、false で有効化します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_example/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"isDisable":true}'
レスポンス¶
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 ファイル形式エラー | パラメータ表に従ってオブジェクトを送信し、storagePolicy には JSON オブジェクトを使用してください。 |
| 429 | ft.OperationTooFrequently | 同一ワークスペースのストレージ書き込み/インデックス関係の同時操作、またはロックリースの失効 | 操作が頻繁すぎます。しばらくしてから再試行してください | 進行中の操作が完了するのを待ってからバックオフして再試行し、まず現在の状態を確認してください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、下流接続/通常の 5xx、またはフィールド形状の異常 | 内部エラー | まず設定を読み取り、実際のストレージの現在の状態を確認してください。失敗が続く場合は traceId を提供してください。エラーを未保存または直接重複追加可能と見なさないでください。 |
| 400 | ft.DefaultIndexUnsupportAction | 対象が default | デフォルトインデックスはこの操作をサポートしていません | デフォルトインデックスはこの有効化/無効化エントリを使用しません。 |
| 404 | ft.LogIndexCfgNoExists | 指定された本ワークスペースの未削除インデックスが存在しない | 指定されたログインデックス設定が存在しません | 一覧から有効な UUID を再取得してください。 |
| 400 | ft.LogIndexCloneRelationInvalid | ソース/クローン関係が変更済み | ログインデックスのクローン関係が無効です | 関連設定を更新してから再試行してください。 |
| 400 | ft.LogIndexCloneSourceUnsupported | クローンソースが内部の通常インデックス条件を満たさなくなっている | 指定されたログインデックスはクローンソースとしてサポートされていません | A/B の状態とタイプを確認してください。 |
| 403 | ft.Forbidden | 権限不足、または現在のバージョンでこの API が許可されていない | 操作権限がありません | 対応するインデックス権限を持つ API Key とサポート対象バージョンを使用してください。 |