调用UpdateIndex接口更新指定Logstore的索引。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

PUT /logstores/{logstore}/index HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
Object Body

A short description of struct

logstoreName String Body logstore-4

Logstore名称。

keys Object Body

字段索引配置,key为字段名称,value为字段索引配置。

token Array of String Body ["\n","\t","\r"]

分词符列表。可以设置一个分词参数,指定这个字段按照哪一种方式分词。

caseSensitive Boolean Body true

是否大小写敏感。

  • true:大小写敏感。
  • false:大小写不敏感。
chn Boolean Body false

是否包含中文。仅当type参数取值为text时,必须设置。

  • true:包含中文。
  • false:不包含中文。
include_keys Array of String Body

包含的字段列表,不能与exclude_keys同时指定。

exclude_keys Array of String Body

排除的字段列表,不能与include_keys同时指定。

line Object Body

全文索引配置。

type String Body text

字段类型。

alias String Body agent_alias

字段别名。

chn Boolean Body false

是否包含中文。仅当type参数取值为text时,必须设置。

  • true:包含中文。
  • false:不包含中文。
token Array of String Body ["\n","\t","\r"]

分词符列表。仅当type参数取值为text时,必须设置。

caseSensitive Boolean Body true

是否大小写敏感。仅当type参数取值为text时,必须设置。

  • true:大小写敏感。
  • false:大小写不敏感。
doc_value Boolean Body true

是否开启统计。

  • true:开启统计。
  • false:不开启统计。

返回数据

名称 类型 示例值 描述
Server String nginx

服务器名称。

Content-Length String 0

响应内容长度。

Connection String close

是否长链接。取值包括:

  • close:不是长链接,则每个HTTP请求都会重新建立TCP连接。
  • keep-alive:长链接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。
Access-Control-Allow-Origin String *

允许所有跨域脚本访问该资源。

Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

示例

请求示例

PUT /logstores/<logstoreName>/index HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

{
  "logstoreName" : "logstore-4",
  "keys" : {
    "token" : [ "[\"\\n\",\"\\t\",\"\\r\"]" ],
    "caseSensitive" : true,
    "chn" : false
  },
  "include_keys" : [ "无" ],
  "exclude_keys" : [ "无" ],
  "line" : {
    "type" : "text",
    "alias" : "agent_alias",
    "chn" : false,
    "token" : [ "[\"\\n\",\"\\t\",\"\\r\"]" ],
    "caseSensitive" : true,
    "doc_value" : true
  }
}

正常返回示例

JSON格式

HTTP/1.1 200 OK

错误码

访问错误中心查看更多错误码。