All Products
Search
Document Center

Simple Log Service:UpdateIndex

更新時間:Nov 13, 2024

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.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
log:UpdateIndexupdate
  • LogStore
    acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}
  • log:TLSVersion
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

ali-test-project
logstorestringYes

The name of the Logstore.

test-logstore
bodyobjectYes

The request body.

keysobjectNo

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.

objectYes

The index configuration of the field.

caseSensitivebooleanNo

Specifies whether to enable case sensitivity. Valid values:

  • true
  • false
false
chnbooleanNo

Specifies whether to include Chinese characters. This parameter is required only when type is set to text. Valid values:

  • true
  • false
false
typestringYes

The data type of the field value. Valid values: text, json, double, and long.

text
aliasstringNo

The alias of the field.

myAlias
tokenarrayYes

The delimiters that are used to split text. This parameter is required only when type is set to text.

stringNo

The delimiter that is used to split text.

.
doc_valuebooleanYes

Specifies whether to turn on Enable Analytics for the field.

false
lineobjectNo

The configuration of full-text indexes.

chnbooleanYes

Specifies whether to include Chinese characters. Valid values:

  • true
  • false
false
caseSensitivebooleanYes

Specifies whether to enable case sensitivity. Valid values:

  • true
  • false
true
tokenarrayYes

The delimiters that are used to split text.

stringNo

The delimiter that is used to split text.

,
include_keysarrayNo

The included fields. You cannot specify both include_keys and exclude_keys.

stringNo

The included field.

includeField
exclude_keysarrayNo

The excluded fields. You cannot specify both include_keys and exclude_keys.

stringNo

The excluded field.

excludeField
ttlintegerYes

The retention period of data. Unit: days. Valid values: 7, 30, and 90.

30
max_text_lenintegerNo

The maximum length of a field value that can be retained.

2048
log_reducebooleanNo

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_listarrayNo

The fields in the whitelist that you want to use to cluster logs.

stringNo

The field in the whitelist.

user
log_reduce_black_listarrayNo

The fields in the blacklist that you want to use to cluster logs.

stringNo

The field in the blacklist.

time

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring

The name of the server.

nginx
Content-Typestring

The content type of the response body.

application/json
Content-Lengthstring

The content length of the response body.

0
Connectionstring

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
Datestring

The time when the response was returned.

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

The request ID.

5B0A6B60BB6EE39764D458B5

Examples

Sample success responses

JSONformat

{}

Error codes

For a list of error codes, visit the Service error codes.