Updates the indexes of a Logstore.
Operation description
Debugging
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:UpdateIndex | update |
|
| none |
Request syntax
PUT /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 |
body | object | Yes | 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:
| false |
chn | boolean | No | Specifies whether to include Chinese characters. This parameter is required only when type is set to text. Valid values:
| false |
type | string | Yes | The data type of the field value. Valid values: text, json, double, and 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:
| false |
caseSensitive | boolean | Yes | Specifies whether to enable case sensitivity. Valid values:
| 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 | 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 parameters
Examples
Sample success responses
JSON
format
{}
Error codes
For a list of error codes, visit the Service error codes.