Describe Index
Updated at：2025-11-03
Description
Retrieve the specified logstore index.
Request
- Request syntax
Http
1GET /v1/logstore/{logStoreName}/index?project={project} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>- Request headers
No additional headers are required beyond the standard request headers.
- Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| project | String | No | Query | Project name, default |
| logStoreName | String | Yes | Path | Logstore name |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
| Parameter name | Types | Description |
|---|---|---|
| fulltext | Boolean | Whether to enable the full-text index; true indicates “Enable” |
| fields | Object | Field name and type information in the field-level index |
| caseSensitive | Boolean | Whether to enable the case sensitive for full-text index; true indicates “Enable the case sensitive” |
| includeChinese | Boolean | Whether to include Chinese; true indicates “Include Chinese” |
| separators | String | Full-text tokenizer |
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 | Description |
|---|---|---|
| type | String | Field type, options: bool, long, text, float |
| caseSensitive | Boolean | Whether to enable the case sensitive for field; true indicates “Enable the case sensitive” |
| includeChinese | Boolean | Whether to include Chinese in field; true indicates “Include Chinese” |
| separators | String | Field tokenizer |
| dynamicMapping | Boolean | Whether to enable the json dynamic index for fields; true indicates “Enable the json dynamic index” |
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 exists | LogStore not exists | 404 |
Example
- Request example
Plain Text
1GET /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- Response example
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3{
4 "fulltext": true,
5 "caseSensitive" : true,
6 "includeChinese" : true,
7 "separators" : "@&?",
8 "fields": {
9 "age": {
10 "type": "long",
11 "caseSensitive" : true,
12 "includeChinese" : true,
13 "separators" : "@&?",
14 "dynamicMapping" : false
15 },
16 "salary": {
17 "type": "float",
18 "caseSensitive" : true,
19 "includeChinese" : false,
20 "separators" : "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
21 "dynamicMapping" :false
22 }
23 }
24}