インデックスキーフィールドの取得¶
GET /api/v1/workspace/index_key_field/get
概要¶
ログインデックスのキーフィールド表示設定を読み取ります。デフォルトインデックスとクローンインデックスが含まれます。
呼び出し前の準備と使用手順¶
ワークスペースは API Key によって決まります。ログインデックス/エクスプローラー管理権限を持つ Key を使用してください。キーフィールド設定はログ表示とオプションの高速化を制御しますが、実際のログフィールド名、履歴ログの値、単位の説明は変更しません。インデックス UUID とインデックス名は混在させないでください。
content.cfgList を読み取った後、cfg_uuid を使用してキーフィールド変更リクエストの uuid に反映し、name を使用してフィールド高速化リクエストの index に反映します。外部にバインドされたストレージのインデックスはこのリストに含まれません。デフォルトインデックスは、永続設定がまだない場合でも default と空のフィールドを返しますが、今回の GET で新しい設定が保存されたことを意味しません。過去のデフォルト設定レイアウトは互換性を保って読み取られます。このインターフェースはグローバルの syncKeywordSpeed スイッチを返さず、高速化タスクの完了進捗も照会しません。変更が必要な場合は、事前にワークスペース管理者がグローバル同期ポリシーを決定してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/workspace/index_key_field/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.cfgList | array<object> | デフォルトインデックスが先頭にあり、その後ろに現在のワークスペースで削除されておらず、外部バインドされていないインデックスが続きます。クローンインデックスを含みます。ページネーションはありません。 |
| content.cfgList[*].cfg_uuid | string | デフォルト項目は固定で default です。それ以外はインデックス設定 UUID です。変更時は cfgList[*].uuid にマッピングされるため、フィールド名が異なる点に注意してください。 |
| content.cfgList[*].name | string | ログインデックスの名前。フィールド高速化リクエストの index に使用します。 |
| content.cfgList[*].extendFields | array<object> または履歴 JSON 値 | 現在のキーフィールド配列です。省略時は [] です。履歴値は完全に正規化されていない可能性があるため、実際の構造で判断してください。異常値は事前に確認してから変更してください。 |
| content.cfgList[*].extendFields[*].tag | string | 実際のフィールド名であり、表示エイリアスではありません。 |
| content.cfgList[*].extendFields[*].alias | string | 任意の表示エイリアスです。省略または空にできます。 |
| content.declaration | object | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"cfgList": [
{
"cfg_uuid": "default",
"name": "default",
"extendFields": [
{
"tag": "host",
"alias": "主机"
},
{
"tag": "service",
"alias": "服务"
}
]
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 設定の読み取りまたは履歴設定データの処理に失敗 | 内部エラー | traceId を保持したまま管理者に連絡して設定を確認し、修正後に再読み取りしてください。 |