UpdateIndex - Simple Log Service - Alibaba Cloud Documentation Center

Updates the indexes of a Logstore.

Operation description

Usage notes

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
body	object	No	The request body.
keys	object	No	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	Yes	The index configuration of the field.
caseSensitive	boolean	No	Specifies whether to enable case sensitivity. Valid values: true false	false
chn	boolean	No	Specifies whether to include Chinese characters. This parameter is required only when type is set to text. Valid values: true false	false
type	string	Yes	The data type of the field value. Valid values: text, json, double, and long. Valid values: double : double json : json text : text long : long	text
alias	string	No	The alias of the field.	myAlias
token	array	Yes	The delimiters that are used to split text. This parameter is required only when type is set to text.
	string	No	The delimiter that is used to split text.	.
doc_value	boolean	Yes	Specifies whether to turn on Enable Analytics for the field.	false
line	object	No	The configuration of full-text indexes.
chn	boolean	Yes	Specifies whether to include Chinese characters. Valid values: true false	false
caseSensitive	boolean	Yes	Specifies whether to enable case sensitivity. Valid values: true false	true
token	array	Yes	The delimiters that are used to split text.
	string	No	The delimiter that is used to split text.	,
include_keys	array	No	The included fields. You cannot specify both include_keys and exclude_keys.
	string	No	The included field.	includeField
exclude_keys	array	No	The excluded fields. You cannot specify both include_keys and exclude_keys.
	string	No	The excluded field.	excludeField
ttl	integer	Yes	The retention period of data. Unit: days. Valid values: 7, 30, and 90.	30
max_text_len	integer	No	The maximum length of a field value that can be retained.	2048
log_reduce	boolean	No	Specifies whether to turn on LogReduce. If you turn on LogReduce, only one of `log_reduce_white_list` and `log_reduce_black_list` takes effect.	false
log_reduce_white_list	array	No	The fields in the whitelist that you want to use to cluster logs.
	string	No	The field in the whitelist.	user
log_reduce_black_list	array	No	The fields in the blacklist that you want to use to cluster logs.
	string	No	The field in the blacklist.	time

Response elements

Element

Type

Description

Example

None defined.

Examples

Success response

JSON format

{}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.