调用GetIndex接口查询指定Logstore的索引。

接口说明

请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
logstore String Path test-logstore

Logstore名称。

返回数据

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

服务器名称。

Content-Type String application/json

响应内容类型。

Content-Length String 0

响应内容长度。

Connection String close

是否长链接。取值包括:

  • close:不是长链接,则每个HTTP请求都会重新建立TCP连接。
  • keep-alive:长链接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。
Date String Sun, 27 May 2018 08:25:04 GMT

当前返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

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

index_mode String v2

索引类型。

keys Map

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

Object

单个字段的索引配置。

caseSensitive Boolean false

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

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

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

  • true:包含中文。
  • false:不包含中文。
token Array of String ,

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

type String text

索引的字段类型。支持text、json、double、long四种类型。

doc_value Boolean false

是否开启字段统计。

  • true:开启统计。
  • false:不开启统计。
alias String myAlias

字段别名。

line Object

全文索引配置。

include_keys Array of String includeField

包含字段列表。

exclude_keys Array of String excludeField

排除字段列表。

chn Boolean false

是否包含中文。

  • true:包含中文。
  • false:不包含中文。
token Array of String ,

分词符。例如 "," "." "\r" "\n" 等。

caseSensitive Boolean false

是否大小写敏感。

  • true:大小写敏感。
  • false:大小写不敏感。
storage String pg

存储类型,目前固定取值为pg。

ttl Integer 30

索引文件生命周期,支持7天、30天、90天。

lastModifyTime Long 1524155379

索引最后更新时间。Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。

log_reduce Boolean false

是否开启日志聚类。

max_text_len Integer 2048

日志服务默认字段值的最大长度为2048字节,即2 KB。如果您需要修改字段值的最大长度,可设置统计字段(text)最大长度,取值范围为64~16384字节。

log_reduce_black_list Array of String b

黑名单字段。

log_reduce_white_list Array of String a

白名单字段。

示例

请求示例

GET /logstores/test-logstore/index HTTP/1.1
Host:ali-test-project.sls.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "index_mode" : "v2",
  "keys" : {
    "key" : {
      "caseSensitive" : false,
      "chn" : false,
      "token" : [ "," ],
      "type" : "text",
      "doc_value" : false,
      "alias" : "myAlias"
    }
  },
  "line" : {
    "include_keys" : [ "includeField" ],
    "exclude_keys" : [ "excludeField" ],
    "chn" : false,
    "token" : [ "," ],
    "caseSensitive" : false
  },
  "storage" : "pg",
  "ttl" : 30,
  "lastModifyTime" : 1524155379,
  "log_reduce" : false,
  "max_text_len" : 2048,
  "log_reduce_black_list" : [ "b" ],
  "log_reduce_white_list" : [ "a" ]
}

错误码

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

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

ProjectNotExist

Project does not exist.

Project不存在。

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

404

IndexConfigNotExist

index config doesn’t exist.

查询的索引不存在。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

更多信息,请参见通用错误码