GetIndex - Simple Log Service - Alibaba Cloud Documentation Center

Queries the index of a Logstore.

Operation description

Usage notes

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
log:GetIndex	get	*LogStore `acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}`	log:TLSVersion	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
logstore	string	Yes	The name of the Logstore.	test-logstore

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The format in which the response body is returned.	application/json
Content-Length	string	The length of the response body.	0
Connection	string	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.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
	object	The information about the index.
index_mode	string	The type of the index.	v2
keys	object	The configurations of field indexes. A field index is in the key-value format in which the key specifies the name of the field and the value specifies the index configuration of the field.
	object	The configurations of the field index.
caseSensitive	boolean	Indicates whether case sensitivity is enabled. This parameter is required only when type is set to text. Valid values: true false	false
chn	boolean	Indicates whether Chinese characters are included. This parameter is required only when type is set to text. Valid values: true false	false
token	array	The delimiters.
	string	The delimiter. This parameter is required only when type is set to text.	,
type	string	The data type of the field value. Valid values: text, json, double, and long.	text
doc_value	boolean	Indicates whether the analytics feature is enabled for the field. Valid values: true false	false
alias	string	The alias of the field.	myAlias
line	object	The configurations of full-text indexes.
include_keys	array	The included fields.
	string	The included field.	includeField
exclude_keys	array	The excluded fields.
	string	The excluded field.	excludeField
chn	boolean	Indicates whether Chinese characters are included. Valid values: true false	false
token	array	The delimiters.
	string	The delimiter. Examples: ",", ".", "\r", and "\n".	,
caseSensitive	boolean	Indicates whether case sensitivity is enabled. Valid values: true false	false
storage	string	The storage type. The value is fixed as pg.	pg
ttl	integer	The lifecycle of the index file. Valid values: 7, 30, and 90. Unit: day.	30
lastModifyTime	long	The time when the index configurations were last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1524155379
log_reduce	boolean	Indicates whether the log clustering feature is enabled.	false
max_text_len	integer	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.	2048
log_reduce_black_list	array	The fields in the blacklist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.
	string	The field in the blacklist.	b
log_reduce_white_list	array	The fields in the whitelist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.
	string	The field in the whitelist.	a

Examples

Sample success responses

JSONformat

{
  "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 Service error codes.