インデックス情報の取得¶
GET /api/v1/log_index_cfg/{cfg_uuid}/get
概要¶
現在のワークスペースにある特定のログインデックスの設定を取得します。フィールドマッピングの返却を選択できます。
呼び出し前の確認と使用手順¶
ログインデックス一覧から現在のワークスペースのインデックス UUID を取得します。デフォルトインデックスには default を使用します。バインドされたストレージの接続設定は、必要な場合にのみ読み取ります。accessCfg にはアクセス認証情報や可逆エンコードされた内容が含まれる可能性があるため、認証情報として保護してください。例では一般的なフィールドを抜粋しています。呼び出し認証情報には log.indexManage または log.externalIndexManage 権限が必要です。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfg_uuid | string | Y | 対象のログインデックス設定 UUID。default も指定できます。 例: default取得または入力方法: ログインデックス一覧の content[].uuid またはページネーションされた content.data[].uuid から取得します。現在のワークスペース内のインデックスのみを使用してください。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの呼び出し認証情報。レコード UUID と呼び出し認証情報は異なるフィールドです。 例: <DF-API-KEY>取得または入力方法: 現在のワークスペースの API キー管理から完全な認証情報を取得します。 |
クエリリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isShowAccessCfg | boolean | accessCfg を返すかどうか。デフォルトは false。 例: false取得または入力方法: 接続設定が本当に必要な場合にのみ true を指定します。 |
|
| isShowFields | boolean | フィールドマッピングを返すかどうか。デフォルトは false。 例: true取得または入力方法: クエリ可能なフィールドのマッピングを確認する必要がある場合に true を指定します。 |
パラメータの補足説明¶
例に記載されているリソース識別子はプレースホルダーです。対象ワークスペースの実際の値に置き換えてください。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/log_index_cfg/default/get' \
--data-urlencode "isShowFields=true"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.uuid | string | インデックス設定の識別子。通常の行はインデックス詳細の取得に使用し、デフォルトインデックスでは default を使用します。 |
| content.name | string | ログインデックスの名前。 |
| content.workspaceUUID | string | インデックスが属するワークスペース。 |
| content.duration | string | ログの保持期間(例: 14d)。外部ストレージにバインドされたインデックスでは空になる場合があります。 |
| content.isBindCustomStore | integer または boolean | 外部ストレージにバインドされている場合は 1、通常のマネージドインデックスの場合は 0。デフォルト行では false が返される場合があります。 |
| content.queryType | string | インデックスがサポートするクエリタイプ。 |
| content.directIndex | integer | 通常のインデックスのネイティブ直接書き込みフラグ。1 は「はい」、0 は「いいえ」を表します。デフォルトインデックスでは省略される場合があります。 |
| content.sortNo | string または integer | インデックス設定で並べ替えに使用される値。デフォルトインデックスでは -1 になる場合があります。 |
| content.storeType | string | インデックスに関連付けられたストレージタイプ。デフォルトインデックスでは省略される場合があります。 |
| content.accessCfg | object | isShowAccessCfg=true の場合にのみ返されます。ストレージアクセスの認証情報を含む場合があります。 |
| content.fields | array<object> |
isShowFields=true の場合にのみ返されるマッピング一覧。デフォルトインデックスではフィールドが存在しない場合があります。 |
| content.fields[].field | string | クエリで使用するフィールド名。 |
| content.fields[].originalField | string | ソースストレージ内のフィールド名。 |
| content.cloneConfig | object または null | クローンインデックスの設定。通常のインデックスでは空になる場合があります。 |
| content.sourceIndexName | string | クローンインデックスに関連付けられたソースインデックス名。 |
| content.regionInfo | object | ストレージリージョンまたは認可情報。デフォルトインデックスは {} です。 |
| content.declaration | object または null | ワークスペースの宣言。 |
{
"code": 200,
"content": {
"uuid": "default",
"name": "default",
"workspaceUUID": "wksp_example",
"duration": "14d",
"isBindCustomStore": false,
"queryType": "logging",
"sortNo": -1,
"declaration": null,
"regionInfo": {},
"fields": []
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていないパラメータが渡された、またはパラメータ値が検証に失敗した | パラメータ検証に失敗しました。メッセージに無効なフィールドが示されます。 | 各フィールドの位置と指定可能な値を確認してください。 |
| 404 | ft.LogIndexCfgNoExists | 設定がこのワークスペースに属していない、削除済み、存在しない、またはクローンインデックスのソースが利用できなくなっている | 指定されたログインデックス設定が存在しません。 | 同じワークスペースの一覧からインデックス識別子を再取得し、クローン元がまだ存在するか確認してください。 |