Modify Index Acceleration Field Configuration¶

POST /api/v1/workspace/index_speed_field/modify

Overview¶

Configure index query acceleration fields.
Currently, only log-type indexes under the ScopeDB storage engine are supported.
Index information comes from the 日志-索引-列表 API.
Index field information can be queried with the DQL statement SHOW_LOGGING_FIELD(index='xx'). fieldSpeedConfig is processed field by field in order. If a field fails, an error is returned immediately and subsequent fields are not processed. Fields that have already succeeded are retained; no bulk rollback is performed. The caller can handle the error and resubmit the same list. Existing indexes continue to use downstream idempotent processing. The quantity limit remains unchanged, and no in-program automatic retry is added.

Body Request Parameters¶

Parameter	Type	Required	Description
fieldSpeedConfig	array		Field acceleration configuration Allow empty: False
fieldSpeedConfig[*]	None
fieldSpeedConfig[*].index	string		Index name, from the `name` field in the log index list Example: `default` Allow empty: False
fieldSpeedConfig[*].field	string	Y	Field Example: `dest_host` Allow empty: False
fieldSpeedConfig[*].enable	boolean	Y	Whether to enable Example: `False` Allow empty: False
fieldSpeedConfig[*].indexType	string		Index type. An empty value or `materialized` indicates a normal/materialized index; `search` adds an inverted index Example: `search` Allow empty: True Allow empty string: True
namespace	string		Namespace. The full namespace name in DQL is lowercase Allow empty: False
source	string		Source Allow empty: False

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/workspace/index_speed_field/modify' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-raw '{"namespace":"logging","fieldSpeedConfig":[{"index":"default","field":"dest_host","enable":false}]}' \
  --insecure

Response¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "xxxxxx"
}