Skip to content

Index Key Field Modification¶

POST /api/v1/workspace/index_key_field/modify

Overview¶

Modification of index key fields

Currently only supports log types.Index information comes from the Log-Index-List interface Index field information can be queried via the DQL statement SHOW_LOGGING_FIELD(index='xx')

Body Request Parameters¶

Parameter Name	Type	Required	Description
cfgList	array		List of key field information to be updated Allow empty: False
cfgList[*]	None
cfgList[*].uuid	string	Y	Index configuration UUID, currently only supports log index. Corresponds to the `uuid` field in the log index list interface response Example: message Allow empty: False
cfgList[*].extendFields	array	Y	Original field name Allow empty: False Allow empty string: True
cfgList[].extendFields[]	None
cfgList[].extendFields[].tag	string	Y	Original field name Example: abc Allow empty: False
cfgList[].extendFields[].alias	string		Field name alias Example: alias value Allow empty: False Allow empty string: True
syncKeywordSpeed	boolean		Whether to synchronize keyword acceleration Example: True Allow empty: False

Parameter Additional Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/workspace/index_key_field/modify' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-raw '{"syncKeywordSpeed":true,"cfgList":[{"uuid":"default","extendFields":[{"tag":"source"},{"tag":"service"},{"tag":"__source"}]}]}' \
  --insecure

Response¶

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