请求语法
POST /SetIndexTemplate HTTP/1.1
Authorization: <AuthorizationString>
x-klog-api-version: 0.1.0
Host: <Project Endpoint>
x-klog-signature-method: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: <Content-MD5>
Content-Length: <ContentLength>
Connection: Keep-Alive
{
"ProjectName": <ProjectName>,
"LogPoolName" : <LogPoolName>,
"IndexStatus" : <IndexStatus>,
"FullTextIndex":(FullTextIndex),
"IndexFields":<List(IndexField)>
}
请求参数
该接口无特有请求头。获取更多信息,请参见公共请求头
参数详情具体如下表。
参数名称 |
类型 |
是否必须 |
描述 |
ProjectName |
String |
是 |
工程名称 |
LogPoolName |
String |
是 |
日志池名称 |
IndexStatus |
Boolean |
是 |
索引状态,true表示开启,false表示关闭 |
FullTextIndex |
FullTextIndex |
是 |
各字段默认的配置项,包括区分大小写、分词符。对未配置索引的字段生效 |
IndexFields |
List |
是 |
字段索引配置项 |
参数名称 |
类型 |
是否必须 |
描述 |
Lowercase |
boolean |
是 |
true表示区分大小写,false表示不区分大小写 |
Chinese |
boolean |
否 |
是否启用中文分词。启用中文分词后,Separator不起作用 |
Separator |
string |
是 |
分词符 |
参数名称 |
类型 |
是否必须 |
描述 |
FieldName |
string |
是 |
字段名称 |
FieldType |
string |
是 |
数据类型,包括text、long、double、date、json类型 |
FieldAlias |
string |
否 |
字段别名,不可与字段名相同。当数据类型为json时,不支持该项设置 |
Lowercase |
Boolean |
否 |
true表示区分大小写,false表示不区分大小写,当数据类型是text时,该项可配置 |
Chinese |
Boolean |
否 |
启用中文分词后,Separator不起作用。当数据类型是text时,该项可配置 |
Separator |
string |
否 |
分词符。当数据类型是text时,该项可配置 |
SubFields |
List |
否 |
当字段数据类型为json时,可选择性填写该项 |
参数名称 |
类型 |
是否必须 |
描述 |
FieldName |
string |
是 |
子字段名称 |
FieldType |
string |
是 |
子字段数据类型,包括text、long、double、date类型 |
FieldAlias |
string |
否 |
子字段别名,不可与字段名相同。当数据类型为json时,不支持该项设置 |
Lowercase |
Boolean |
否 |
true表示区分大小写,false表示不区分大小写,当数据类型是text时,该项可配置 |
Chinese |
Boolean |
否 |
启用中文分词后,Separator不起作用。当数据类型是text时,该项可配置 |
Separator |
string |
否 |
分词符。当数据类型是text时,该项可配置 |
示例
请求示例
POST /SetIndexTemplate HTTP/1.1
Authorization: <AuthorizationString>
x-klog-api-version: 0.1.0
Host: <Project Endpoint>
x-klog-signature-method: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: <Content-MD5>
Content-Length: <ContentLength>
Connection: Keep-Alive
{
"ProjectName": "testproject",
"LogPoolName": "testlogpool",
"IndexStatus": true,
"FullTextIndex": {
"Lowercase": false,
"Separator": ""
},
"IndexFields": [
{
"FieldName": "message",
"FieldType": "text",
"Lowercase": true,
"Separator": "';=()[]{}?@&<>/:\n\t\r"
},
{
"FieldName": "log",
"FieldType": "json",
"SubFields": [
{
"FieldName": "offset",
"FieldType": "long"
}
]
}
]
}
响应示例
HTTP/1.1 200
Server: nginx
Content-Length: 0
Connection: close
Access-Control-Allow-Origin: *
Date: Sun, 27 May 2018 07:43:27 GMT
x-klog-requestid: 5B0A619F205DC3F30EDA9322