GetIndex - 获取索引_日志服务(SLS)-阿里云帮助中心

查询指定Logstore的索引信息。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /logstores/{logstore}/index

请求参数

名称	类型	必填	描述	示例值
project	string	是	project 名称。	ali-test-project
logstore	string	是	Logstore 名称。	test-logstore

返回参数

名称	类型	描述	示例值
headers	object
Server	string	服务器名称。	nginx
Content-Type	string	响应内容类型。	application/json
Content-Length	string	响应内容长度。	0
Connection	string	是否长链接。取值包括： close：不是长链接，则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive：长链接，TCP 连接建立后保持连接状态，节省连接所需时间和带宽。	close
Date	string	当前返回响应的时间。	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	服务端产生的标识，该请求的唯一 ID。	5B0A6B60BB6EE39764D458B5
	object	请求返回的结构体。
index_mode	string	索引类型。	v2
keys	object	字段索引配置。key 为字段名称，value 为索引配置。
	object	单个字段的索引配置。
caseSensitive	boolean	是否大小写敏感。仅当 type 参数取值为 text 时，必须设置。 true：大小写敏感。 false：大小写不敏感。	false
chn	boolean	是否包含中文。仅当 type 参数取值为 text 时，必须设置。 true：包含中文。 false：不包含中文。	false
token	array	分词符列表。
	string	分词符列表。仅当 type 参数取值为 text 时，必须设置。	,
type	string	索引的字段类型。支持 text、json、double、long 四种类型。	text
doc_value	boolean	是否开启字段统计。 true：开启统计。 false：不开启统计。	false
alias	string	字段别名。	myAlias
line	object	全文索引配置。
include_keys	array	包含的字段列表。
	string	包含字段列表。	includeField
exclude_keys	array	排除的字段列表。
	string	排除字段列表。	excludeField
chn	boolean	是否包含中文。 true：包含中文。 false：不包含中文。	false
token	array	分词符列表。
	string	分词符。例如 "," "." "\r" "\n" 等。	,
caseSensitive	boolean	是否大小写敏感。 true：大小写敏感。 false：大小写不敏感。	false
storage	string	存储类型，目前固定取值为 pg。	pg
ttl	integer	索引文件生命周期，支持 7 天、30 天、90 天。	30
lastModifyTime	long	索引最后更新时间。Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。	1524155379
log_reduce	boolean	是否开启日志聚类。	false
max_text_len	integer	日志服务默认字段值的最大长度为 2048 字节，即 2 KB。如果您需要修改字段值的最大长度，可设置统计字段（text）最大长度，取值范围为 64~16384 字节。	2048
log_reduce_black_list	array	日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效。
	string	黑名单字段。	b
log_reduce_white_list	array	日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效
	string	白名单字段。	a

示例

正常返回示例

JSON格式

{
  "index_mode": "v2",
  "keys": {
    "key": {
      "caseSensitive": false,
      "chn": false,
      "token": [
        ","
      ],
      "type": "text",
      "doc_value": false,
      "alias": "myAlias",
      "vector_index": "",
      "embedding": ""
    }
  },
  "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.	内部服务调用错误。

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