Queries the indexes of a specified Logstore.

Description

Host consists of a project name and a Log Service endpoint. You must specify a project in Host.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
logstore String Path Yes test-logstore

The name of the Logstore.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Type String application/json

The type of the response body.

Content-Length String 0

The length of the response body.

Connection String close

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
Date String Sun, 27 May 2018 08:25:04 GMT

The time at which the response is returned.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The unique ID of the request. The ID is generated by Log Service.

index_mode String v2

The type of the indexes.

keys Map

The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field.

Object

The index configuration of the field.

caseSensitive Boolean false

Specifies whether case sensitivity is enabled. Valid values: This parameter is required when the type parameter is set to text.

  • true: Case sensitivity is enabled.
  • false: Case sensitivity is disabled.
chn Boolean false

Specifies whether Chinese characters are included. This parameter is required when the type parameter is set to text.

  • true: Chinese characters are included.
  • false: Chinese characters are not included.
token Array of String ,

The delimiters. This parameter is required when the type parameter is set to text.

type String text

The field type based on which the index is created. Valid values: text, json, double, and long.

doc_value Boolean false

Specifies whether Enable Analytics is turned on for the field.

  • true: Enable Analytics is turned on.
  • false: Enable Analytics is turned off.
alias String myAlias

The alias of the field.

line Object

The configuration of full-text indexes.

include_keys Array of String includeField

The included fields.

exclude_keys Array of String excludeField

The excluded fields.

chn Boolean false

Specifies whether Chinese characters are included.

  • true: Chinese characters are included.
  • false: Chinese characters are not included.
token Array of String ,

The delimiters. Examples: ",", ".", "\r", and "\n".

caseSensitive Boolean false

Specifies whether case sensitivity is enabled. Valid values:

  • true: Case sensitivity is enabled.
  • false: Case sensitivity is disabled.
storage String pg

The storage type. The value is fixed as pg.

ttl Integer 30

The time to live (TTL) of the index file. Valid values: 7, 30, and 90. Unit: days.

lastModifyTime Long 1524155379

The time when the index configuration was last updated. The value is a timestamp that follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 Thursday, January 1, 1970.

log_reduce Boolean false

Specifies whether the LogReduce feature is enabled.

max_text_len Integer 2048

The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of the max_text_len parameter. Valid values: 64 to 16384. Unit: bytes.

log_reduce_black_list Array of String b

The fields in the blacklist.

log_reduce_white_list Array of String a

The fields in the whitelist.

Examples

Sample requests

GET /logstores/test-logstore/index HTTP/1.1
Host:ali-test-project.sls.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "index_mode" : "v2",
  "keys" : {
    "key" : {
      "caseSensitive" : false,
      "chn" : false,
      "token" : [ "," ],
      "type" : "text",
      "doc_value" : false,
      "alias" : "myAlias"
    }
  },
  "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" ]
}

Error codes

For a list of error codes, visit the API Error Center.

HTTP status code

Error code

Error message

Description

404

ProjectNotExist

Project does not exist.

The error message returned because the specified project does not exist.

404

LogStoreNotExist

Logstore does not exist.

The error message returned because the specified Logstore does not exist.

404

IndexConfigNotExist

index config doesn't exist.

The error message returned because no index configuration exists.

500

InternalServerError

Specified Server Error Message.

The error message returned because an internal server error has occurred.

For more information, see Common error codes.