Queries the indexes of a Logstore.
Usage notes
- Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pairs.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Log Service.
- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
Authentication resources
The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.
Action | Resource |
log:GetIndex | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
Debugging
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 |
project | String | Host | Yes | ali-test-project | The name of the project. |
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:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | The time when the response was returned. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
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 configuration of the field index. | ||
caseSensitive | Boolean | false | Indicates whether case sensitivity is enabled. This parameter is returned only when type is set to text. Valid values:
|
chn | Boolean | false | Indicates whether Chinese characters are included. This parameter is returned only when the type parameter is set to text. Valid values:
|
token | Array of String | , | The delimiters. This parameter is returned only when type 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 | Indicates whether Enable Analytics is turned on for the field. Valid values:
|
alias | String | myAlias | The alias of the field. |
line | Object | The configuration of full-text indexing. | |
include_keys | Array of String | includeField | The included fields. |
exclude_keys | Array of String | excludeField | The excluded fields. |
chn | Boolean | false | Indicates whether Chinese characters are included. Valid values:
|
token | Array of String | , | The delimiters. Examples: ",", ".", "\r", and "\n". |
caseSensitive | Boolean | false | Indicates whether case sensitivity is enabled. Valid values:
|
storage | String | pg | The storage type. Valid value: 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 UTC, Thursday, January 1, 1970. |
log_reduce | Boolean | false | Indicates whether LogReduce is turned on. |
max_text_len | Integer | 2048 | The maximum length of a field value that can be retained. Unit: bytes. Default value: 2048. 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, see Service error codes.
HttpStatusCode | ErrorCode | ErrorMessage | Description |
404 | ProjectNotExist | Project does not exist. | The specified project does not exist. |
404 | LogStoreNotExist | Logstore does not exist. | The specified Logstore does not exist. |
404 | IndexConfigNotExist | index config doesn't exist. | No index configuration exists. |
500 | InternalServerError | Specified Server Error Message. | An internal server error has occurred. |
For more information, see Common error codes.