全部产品
Search

搜索本产品

    日志服务：GetIndex - 获取索引

    文档中心

    日志服务：GetIndex - 获取索引

    更新时间：Sep 25, 2024

    查询指定Logstore的索引信息。

    接口说明

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    log:GetIndexget
    • LogStore
      acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}
    • log:TLSVersion
    		无

    请求语法

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

    请求参数

    名称类型必填描述示例值
    projectstring是

    project 名称。

    		ali-test-project
    logstorestring是

    Logstore 名称。

    		test-logstore

    返回参数

    名称类型描述示例值
    headersobject
    Serverstring

    服务器名称。

    		nginx
    Content-Typestring

    响应内容类型。

    		application/json
    Content-Lengthstring

    响应内容长度。

    		0
    Connectionstring

    是否长链接。取值包括：

    • close：不是长链接，则每个 HTTP 请求都会重新建立 TCP 连接。
    • keep-alive：长链接，TCP 连接建立后保持连接状态，节省连接所需时间和带宽。
    		close
    Datestring

    当前返回响应的时间。

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

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

    		5B0A6B60BB6EE39764D458B5
    object

    请求返回的结构体。

    ttlinteger

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

    		30
    max_text_leninteger

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

    		2048
    log_reduce_white_listarray

    日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效

    string

    白名单字段。

    		a
    log_reduce_black_listarray

    日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效。

    string

    黑名单字段。

    		b
    lineobject

    全文索引配置。

    chnboolean

    是否包含中文。

    • true：包含中文。
    • false：不包含中文。
    		false
    caseSensitiveboolean

    是否大小写敏感。

    • true：大小写敏感。
    • false：大小写不敏感。
    		false
    tokenarray

    分词符列表。

    string

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

    		,
    include_keysarray

    包含的字段列表。

    string

    包含字段列表。

    		includeField
    exclude_keysarray

    排除的字段列表。

    string

    排除字段列表。

    		excludeField
    keysobject

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

    IndexKey

    单个字段的索引配置。

    log_reduceboolean

    是否开启日志聚类。

    		false
    lastModifyTimelong

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

    		1524155379
    index_modestring

    索引类型。

    		v2
    storagestring

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

    		pg

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    HttpStatusCodeErrorCodeErrorMessage错误码描述
    404ProjectNotExistProject does not exist.Project 不存在。
    404LogStoreNotExistLogstore does not exist.Logstore 不存在。
    404IndexConfigNotExistindex config doesn’t exist.查询的索引不存在。
    500InternalServerErrorSpecified Server Error Message.内部服务调用错误。

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