调用GetIndex API查询Logstore的索引信息-日志服务-阿里云-日志服务(SLS)-阿里云帮助中心

查询指定Logstore的索引信息。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

log:GetIndex

get

*LogStore

acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}

log:TLSVersion

无

请求语法

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

路径参数

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

请求参数

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

返回参数

名称	类型	描述	示例值
	object	请求返回的结构体。
index_mode	string	索引类型。	v2
keys	object	字段索引配置。key 为字段名称，value 为索引配置。
	IndexKey	单个字段的索引配置。
lastModifyTime	integer	索引最后更新时间。Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。	1524155379
line	object	全文索引配置。
caseSensitive	boolean	是否大小写敏感。 true：大小写敏感。 false：大小写不敏感。	false
chn	boolean	是否包含中文。 true：包含中文。 false：不包含中文。	false
exclude_keys	array	排除的字段列表。
	string	排除字段列表。	excludeField
include_keys	array	包含的字段列表。
	string	包含字段列表。	includeField
token	array	分词符列表。
	string	分词符。例如 "," "." "\r" "\n" 等。	,
log_reduce	boolean	是否开启日志聚类。	false
log_reduce_black_list	array	日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效。
	string	黑名单字段。	b
log_reduce_white_list	array	日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效
	string	白名单字段。	a
max_text_len	integer	日志服务默认字段值的最大长度为 2048 字节，即 2 KB。如果您需要修改字段值的最大长度，可设置统计字段（text）最大长度，取值范围为 64~16384 字节。	2048
storage	string	存储类型，目前固定取值为 pg。	pg
ttl	integer	索引文件生命周期，支持 7 天、30 天、90 天。	30

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。