CreateIndex
更新时间:2024-09-11
描述
为用户指定的日志集创建索引。
请求
- 请求语法
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>
}
- 请求头域
CreateIndex 接口无特殊请求头,关于 BLS API的公共请求头,请参见公共请求头。
- 请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
project | String | No | Query | 日志组名称,默认default |
logStoreName | String | Yes | Path | 日志集名称 |
fulltext | Boolean | No | RequestBody | 是否开启全文索引,true 表示开启 |
fields | Object | No | RequestBody | 字段索引包含的字段名称及类型定义 |
注:全文索引和字段索引二者必须至少开启其一
其中,fields 为 Map Object 结构,key 即为字段名称,value 为 logField 结构体,以下为 LogField 结构体的定义:
参数名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
type | String | Yes | 字段的类型,支持的类型有:bool、long、text、float |
响应
- 响应头域
CreateIndex 接口无特殊响应头,关于 BLS API的公共响应头,请参见公共响应头。
- 响应元素
无
错误码
除了通用的错误码,还可能出现如下错误码:
错误码 | 错误消息 | 描述 | HTTP状态码 |
---|---|---|---|
IndexAlreadyExist | LogStore index already exists | LogStore 索引已存在 | 409 |
示例
- 请求示例
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,
"fields": {
"age": {
"type": "long"
},
"salary": {
"type": "float"
}
}
}
- 返回示例
HTTP/1.1 201
Content-Type: application/json; charset=utf-8