Update Index
Updated at：2025-11-03
Description
Refresh the index of the specified logstore.
Request
- Request syntax
Http
1PUT /v1/logstore/{logStoreName}/index?project={project} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5{
6 "fulltext": <Fulltext>,
7 "fields": <Fields>,
8 "caseSensitive" : <caseSensitive>,
9 "includeChinese" : <includeChinese>,
10 "separators" : <separators>
11}- Request headers
The UpdateIndex API requires no special request header. For details on the common request headers of the BLS API, please refer to the standard headers documentation.
- Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| project | String | No | Query | Project name, default |
| logStoreName | String | Yes | Path | Logstore name |
| fulltext | Boolean | No | RequestBody | Whether to enable the full-text index; true indicates “Enable” |
| fields | Object | No | RequestBody | Field name and type definition included in the field-level index |
| caseSensitive | Boolean | No | RequestBody | Whether to enable the case sensitive for full-text index; by default (false), disable the case sensitive |
| includeChinese | Boolean | No | RequestBody | Whether to include Chinese; by default (false), exclude Chinese |
| separators | String | No | RequestBody | Full-text tokenizer; if not filled, use the default tokenizer |
Note: At least one of full-text index and field-level index must be enabled
Fields indicates a map object structure, key indicates a field name, and value indicates a logfield structure. The logfield structure is defined as follows:
| Parameter name | Types | Required or not | Description |
|---|---|---|---|
| type | String | Yes | Field type, options: bool, long, text, float |
| caseSensitive | Boolean | No | Whether to enable the case sensitive for field; by default (false), disable the case sensitive |
| includeChinese | Boolean | No | Whether to include Chinese in field; by default (false), exclude Chinese |
| separators | String | No | Field tokenizer; if not filled, use the default tokenizer |
| dynamicMapping | Boolean | No | Whether to enable the json dynamic index; by default (false), it is disabled |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
None
Error code
Apart from standard error codes, the following codes may be returned:
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| IndexNotFound | LogStore index not found | LogStore index not exists | 404 |
Example
- Request example
Text
1PUT /v1/logstore/demo/index?project=default HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8
5
6{
7 "fulltext": true,
8 "caseSensitive" : true,
9 "includeChinese" : true,
10 "separators" : "@&?",
11 "fields": {
12 "age": {
13 "type": "long",
14 "caseSensitive" : true,
15 "includeChinese" : true,
16 "separators" : "@&?",
17 "dynamicMapping" : false
18 },
19 "salary": {
20 "type": "float",
21 "caseSensitive" : true,
22 "includeChinese" : false,
23 "separators" : "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
24 "dynamicMapping" : false
25 }
26 }
27}- Response example
Text
1HTTP/1.1 204
2Content-Type: application/json; charset=utf-8