CreateIndex
Last Updated：2020-10-21
Description
Create an index for the specified log set.
Request
- Request syntax
POST /v1/logstore/{logStoreName}/index HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>
Content-Type: application/json; charset=utf-8
{
"fields": <Fields>
} - Request header
The CreateIndex interface has no special request header. For the public request header of the BLS API, please refer to the public request header.
- Request parameter
| Parameter name | Type | Required or not | Parameter location | Description |
|---|---|---|---|---|
| logStoreName | String | Yes | Path | Log set name |
| fields | Object | Yes | RequestBody | Field names and type definitions included in the index |
Among them, fields is the Map Object structure, the key is the field name, and the value is the logField structure. The following is the definition of the LogField structure:
| Parameter name | Type | Required or not | Description |
|---|---|---|---|
| type | String | Yes | Type of the field, the supported types are: bool、long、text、float |
Response
- Response header
The CreateIndex interface has no special response headers. For the public response headers of the BLS API, see Public Response Headers.
- Response element
None
Error Code
In addition to general error codes, the following error codes may also appear:
| 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 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
{
"fields": {
"age": {
"type": "long"
},
"salary": {
"type": "float"
}
}
} - Return example
HTTP/1.1 201
Content-Type: application/json; charset=utf-8