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

请求语法

GetIndex接口的请求语法如下所示。
GET /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的公共请求头,请参见公共请求头

  • 请求参数
    属性名称 类型 是否必须 描述
    logstoreName string Logstore的名称。

响应参数

  • 响应头

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

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

错误码

GetIndex接口除了返回Log Service API的通用错误码,还可能返回如下特有错误码。
HTTP状态码 ErrorCode ErrorMessage 描述
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 服务器错误信息。

示例

  • 请求示例
    GET /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
    }