Create Index

Last Updated：2025-11-14

Description

Create indexes for user-specified logstores.

Request

Request syntax

POST /v1/logstore/{logStoreName}/index?project={project} HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>
Content-Type: application/json; charset=utf-8
{
  "fulltext": <Fulltext>,
  "fields": <Fields>,
  "caseSensitive" : <caseSensitive>,
  "includeChinese" : <includeChinese>,
  "separators" : <separators>
}

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

POST /v1/logstore/<logstore>/index?project=default HTTP/1.1

Host: bls-log.bj.baidubce.com
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
Content-Type: application/json; charset=utf-8
  
{
  "fulltext": true,
  "caseSensitive" : true,
  "includeChinese" : true,
  "separators" : "@&?",
  "fields": {
    "age": {
      "type": "long",
      "caseSensitive" : true,
      "includeChinese" : true,
      "separators" : "@&?",
      "dynamicMapping" : false
    },
    "salary": {
      "type": "float",
      "caseSensitive" : true,
      "includeChinese" : false,
      "separators" : "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
      "dynamicMapping" : false
    }
  }
}

Response example

HTTP/1.1 201
Content-Type: application/json; charset=utf-8

Download Log Download Related Interfaces

Update Index

百度智能云

Log Service