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

请求语法

GET /project/<projectName>/logstores/<logstoreName>/index HTTP/1.1
Authorization: <AuthorizationString>
x-log-bodyrawsize: 0
User-Agent: <UserAgent>
x-log-apiversion: 0.6.0
Host: <Project Endpoint>
x-log-signaturemethod: hmac-sha1
Date: <GMT Date>
Content-Type: application/x-protobuf
Connection: Keep-Alive

请求参数

  • 请求头

    GetIndex接口无特有请求头,关于Log Service API的公共请求头,请参见公共请求头

  • 参数列表
    属性名称 类型 是否必须 示例值 描述
    projectName string project-t Project的名称。
    logstoreName string logstore-4 Logstore的名称。

返回数据

  • 响应头

    GetIndex接口无特有响应头,关于Log Service API的公共响应头,请参见公共响应头

  • 响应元素
    GetIndex请求成功,其响应Body会包括指定Project和Logstore的索引,具体如下:
    属性名称 类型 示例值 描述
    index_mode string v2 索引类型。
    keys dict 字段索引配置。key为字段名称,value为索引配置。
    line object 全文索引配置。
    storage string pg 存储类型,目前为pg。
    ttl int 30 索引文件生命周期,支持7天、30天、90天。
    lastModifyTime int 1524155379 索引最后更新时间。UNIX时间戳。
    全文索引配置属性
    属性名称 类型 示例值 描述
    caseSensitive bool false 大小写是否敏感。
    chn bool false 是否包含中文。
    token array ["\n","\t","\r"] 分词符列表。
    include_keys array 包含的字段列表。
    exclude_keys array 排除的字段列表。
    字段索引配置属性
    属性名称 类型 示例值 描述
    type string text 字段类型。
    alias string 字段别名。
    chn bool false 是否包含中文,只有type为text时才存在。
    token array ["\n","\t","\r"] 分词符列表,只有type为text时才存在。
    caseSensitive bool false 大小写是否敏感,只有type为text时才存在。
    doc_value bool true 是否开启字段统计。

示例

  • 请求示例
    GET /project/project-t/logstores/logstore-4/index HTTP/1.1
    Authorization: LOG <yourAccessKeyId>:<yourSignature>
    x-log-bodyrawsize: 0
    User-Agent: sls-java-sdk-v-0.6.1
    x-log-apiversion: 0.6.0
    Host: my-project.cn-shanghai.log.aliyuncs.com
    x-log-signaturemethod: hmac-sha1
    Date: Sun, 06 May 2018 13:08:42 GMT
    Content-Type: application/x-protobuf
    Connection: Keep-Alive
  • 正常返回示例
    HTTP/1.1 200
    Server: nginx/1.12.1
    Content-Type: application/json
    Content-Length: 712
    Connection: close
    Access-Control-Allow-Origin: *
    Date: Sun, 06 May 2018 13:08:42 GMT
    x-log-requestid: 5AEEFE5A8B8AEB5E6C82B395
    {
      "index_mode": "v2",
      "keys": {
        "agent": {
          "alias": "",
          "caseSensitive": false,
          "chn": false,
          "doc_value": true,
          "token": [
            ",",
            " ",
            "'",
            "\"",
            ";",
            "=",
            "(",
            ")",
            "[",
            "]",
            "{",
            "}",
            "?",
            "@",
            "&",
            "<",
            ">",
            "/",
            ":",
            "\n",
            "\t",
            "\r"
          ],
          "type": "text"
        },
        "bytes": {
          "alias": "",
          "doc_value": true,
          "type": "long"
        },
        "remote_ip": {
          "alias": "",
          "caseSensitive": false,
          "chn": false,
          "doc_value": true,
          "token": [
            ",",
            " ",
            "'",
            "\"",
            ";",
            "=",
            "(",
            ")",
            "[",
            "]",
            "{",
            "}",
            "?",
            "@",
            "&",
            "<",
            ">",
            "/",
            ":",
            "\n",
            "\t",
            "\r"
          ],
          "type": "text"
        },
        "response": {
          "alias": "",
          "doc_value": true,
          "type": "long"
        }
      },
      "line": {
        "caseSensitive": false,
        "chn": false,
        "token": [
          ",",
          " ",
          "'",
          "\"",
          ";",
          "=",
          "(",
          ")",
          "[",
          "]",
          "{",
          "}",
          "?",
          "@",
          "&",
          "<",
          ">",
          "/",
          ":",
          "\n",
          "\t",
          "\r"
        ]
      },
      "storage": "pg",
      "ttl": 30,
      "lastModifyTime": 1524155379
    }

错误码

HTTP状态码 错误码 错误信息 描述
400 IndexConfigNotExist index config doesn’t exist. 查询的索引不存在。
404 ProjectNotExist The Project does not exist : {Project}. Project不存在。
404 LogStoreNotExist logstore {logstoreName} dose not exist. Logstore不存在。
500 InternalServerError Specified Server Error Message. 服务器错误信息。

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