Create Index
Updated at：2025-11-03
Description
Create indexes for user-specified logstores.
Request
- Request syntax
Http
1POST /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 CreateIndex API doesn't require any special request headers. For common request headers of the BLS API, refer to the common request headers section.
- 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” |
| 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, json |
| 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
The CreateIndex API doesn't include any special response headers. For common response headers of the BLS API, refer to the common response headers section.
- Response element
None
Error code
Apart from standard error codes, the following codes may be returned:
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| IndexAlreadyExist | LogStore index already exists | LogStore index already exists | 409 |
Example
- Request example
Text
1POST /v1/logstore/<logstore>/index?project=default HTTP/1.1
2
3Host: bls-log.bj.baidubce.com
4Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
5Content-Type: application/json; charset=utf-8
6
7{
8 "fulltext": true,
9 "caseSensitive" : true,
10 "includeChinese" : true,
11 "separators" : "@&?",
12 "fields": {
13 "age": {
14 "type": "long",
15 "caseSensitive" : true,
16 "includeChinese" : true,
17 "separators" : "@&?",
18 "dynamicMapping" : false
19 },
20 "salary": {
21 "type": "float",
22 "caseSensitive" : true,
23 "includeChinese" : false,
24 "separators" : "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
25 "dynamicMapping" : false
26 }
27 }
28}- Response example
Text
1HTTP/1.1 201
2Content-Type: application/json; charset=utf-8