ワークスペース - インデックステンプレート設定¶
POST /api/v1/workspace/{workspace_uuid}/update_index_setting
概要¶
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| workspace_uuid | string | Y | ワークスペースUUID |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| data_type | string | Y | データタイプ 空を許可: False 選択可能な値: ['rum', 'logging', 'network', 'tracing', 'profiling', 'keyevent', 'security', 'backup_log', 'apm', 'dialtest'] |
| cfg_uuid | string | 他のインデックス設定UUID 空を許可: False 空文字列を許可: True |
|
| hotRetention | int | ホットストレージ 空を許可: False |
|
| coldRetention | int | 低頻度ストレージ - コールドデータ 空を許可: False |
|
| archiveRetention | int | アーカイブストレージ - アーカイブデータ 空を許可: False |
|
| storagePolicy | json | 長期保存ポリシー。ログは scopedb ストレージのワークスペースのみ有効化できます。pay、enterprise、unlimited はログの長期保存をサポートしています。enterprise/unlimited の logging は最大 1800 日です。enterprise/unlimited の rp はカスタム長期保存期間（最大 3600 日）をサポートしています。unlimited は BossAccountSet が有効な場合、metric_point_total 課金タイプのみサポートし、無効な場合は metric_point_total として処理されます。longStorageEnabled と longStorageDuration を含みます。 空を許可: False |
|
| openAdvancedConfig | int | 詳細設定を有効にするかどうか 空を許可: False |
|
| mappings | json | 他のインデックス設定UUID 空を許可: False |
|
| number_of_shards | int | プライマリシャード 空を許可: False |
|
| number_of_replicas | int | レプリカ数 空を許可: False |
|
| rollover_max_size | int | 単一シャードサイズ。このフィールド名は kodo 側で提供されており、フィールド名に曖昧さがあります。 空を許可: False |
|
| duration | string | データ保存ポリシー 単位 d（日） 例: 7d 空を許可: False |
パラメータの補足説明¶
外部インターフェースの説明。
管理バックエンドがインデックス設定を更新するには、kodo インターフェースを呼び出して変更を行います。
1. kodo インデックス設定更新 パラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| workspace_uuid | String | 必須 | 対応するワークスペースのUUID |
| number_of_shards | int | 任意 | プライマリシャード数 |
| data_type | string | 必須 | インデックスタイプ（列挙値） |
| number_of_replicas | int | 必須（doris は任意） | レプリカ数 |
| rollover_max_size | int | 任意 | シャードサイズ |
2. 管理バックエンドのインデックス設定 説明:
es —> すべて（シャード、レプリカ、ホットデータ保存期間、詳細設定を含む） beaver（日志易）—> なし doris —> ホットストレージ volctls（Volcengine）—> ホットストレージ, 低頻度ストレージ - コールドデータ, アーカイブストレージ - アーカイブデータ sls —> なし
3. パラメータ 説明
| key | 説明 |
|---|---|
| data_type | 非マージインデックスの data_type の選択可能な値: backup_log, keyevent, logging, network, rum, security, tracing, profiling マージインデックスの data_type の選択可能な値: apm, backup_log, keyevent, logging, network |
| rollover_max_size | インデックスのロールオーバー条件を示します。つまり、インデックスがどのくらいの大きさに達したときに新しいインデックスにロールオーバーするかを示します。rollover_max_size = number_of_shards * 単一シャードサイズ |
注意:
実際の rollover_max_size は単一シャードサイズを示し、最大サイズではありません。kodo 側ではまだ新しいフィールドのシャードサイズ名が提供されていないため、rollover_max_size を引き続き使用して単一シャードサイズを表します。変更が必要な場合は、kodo 側が単一シャードサイズを表す新しいフィールドを提供する必要があります。
4. Volcengine ストレージ 説明
- Volcengine ストレージの場合、従来のタイプごとの合計保存期間は現在のホットストレージに対応します。
- Volcengine の場合、保存ポリシーの変更はホットストレージ、低頻度ストレージ、アーカイブストレージの 3 つのタイプに対して行われ、合計保存期間の変更は行われなくなります。インタラクションは蓝湖（Lanhu）を参照してください（管理バックエンドのインデックス設定保存期間変更、フロントエンドのインデックス保存期間変更を含む）。
- Volcengine ストレージ期間の制限： ホットストレージ：ホットデータストレージ、データ範囲は 1 〜 1800 日。低頻度ストレージがある場合、データ範囲は 7 〜 1800 日。アーカイブストレージがある場合、データ範囲は 30 〜 1800 日。 低頻度ストレージ：コールドデータストレージ、データ範囲は 30 〜 1800 日。 アーカイブストレージ：アーカイブデータなどのストレージ、データ範囲は 60 〜 1800 日。
- Volcengine ストレージ期間の制限： 合計保存期間（ホットストレージ + 低頻度ストレージ + アーカイブストレージ）は 1800 日を超えることはできません。