All Products
Search

This Product

    Simple Log Service:index

    Document Center

    Simple Log Service:index

    Last Updated:Sep 15, 2026

    Parameter

    Type

    Description

    Example

    object

    The index configuration data structure.

    Scenario 1 (full-text index only):

    {
    "line": {
        "chn": false,
        "caseSensitive": false,
        "token":[","," ","'","\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\n","\t","\r"]
    }
}

    Scenario 2 (full-text index and field index):

    {
  "keys": {
    "region": {
      "doc_value": true,
      "alias": "",
      "type": "text",
      "caseSensitive": false,
      "chn": false,
      "token": [","," ","'","\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\n","\t","\r"]
    },
    "end_time": {
      "doc_value": true,
      "alias": "",
      "type": "long"
    },
    "request_time": {
      "doc_value": true,
      "alias": "",
      "type": "double"
    }
  },
  "line": {
    "caseSensitive": false,
    "chn": true
  }
}

    keys

    object

    The field index configuration. The key is the field name, and the value is the field index configuration. At least one of the following must exist: full-text index, field index, or scan index. Field index example:

    {
    "region": {
      "doc_value": true,
      "alias": "",
      "type": "text",
      "caseSensitive": false,
      "chn": false,
      "token": [","," ","'","\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\n","\t","\r"]
    },
    "end_time": {
      "doc_value": true,
      "alias": "",
      "type": "long"
    },
    "request_time": {
      "doc_value": true,
      "alias": "",
      "type": "double"
    }
  }

    The field index configuration. The key is the field name, and the value is the field index configuration.

    line

    object

    The full-text index configuration. At least one of the following must exist: full-text index, field index, or scan index. Full-text index example:

    {
    "chn": false,
    "caseSensitive": false,
    "token":[","," ","'","\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\n","\t","\r"]
}

    auto_key_detect

    boolean

    Specifies whether to enable the automatic index discovery feature. After this feature is enabled, fields in logs that do not have indexes are automatically discovered and added to auto_text_keys (automatically discovered indexed fields). The automatically discovered indexed fields are of the text type with analytics enabled. Their case sensitivity and token settings inherit the full-text index configuration.

    false
    auto_text_keys

    array

    The automatically discovered indexed fields. The automatically discovered indexed fields are of the text type with analytics enabled. Their case sensitivity and token settings inherit the full-text index configuration. After automatic index discovery is disabled, the previously discovered indexes are retained unless you explicitly clear this field.

    string

    The automatically discovered indexed fields. The automatically discovered indexed fields are of the text type with analytics enabled. Their case sensitivity and token settings inherit the full-text index configuration.

    host
    caseSensitive

    boolean

    Specifies whether the index is case-sensitive. Default value: false.

    true
    chn

    boolean

    Specifies whether to include Chinese characters. Default value: false. Enabling this option may reduce write performance.

    false
    exclude_keys

    array

    The list of excluded fields. This parameter cannot be specified together with include_keys.

    string

    The list of excluded fields.

    excludeField
    include_keys

    array

    The list of included fields. This parameter cannot be specified together with exclude_keys.

    string

    The list of included fields.

    includeField
    token

    array

    The list of token delimiters. You can set a token parameter to specify how the field is tokenized.

    string

    The token delimiter, such as ",", ".", "\r", or "\n".

    ,
    log_reduce

    boolean

    Specifies whether to enable LogReduce. After LogReduce is enabled, at most one of the whitelist and blacklist takes effect.

    • true: LogReduce is enabled.

    • false (default): LogReduce is not enabled.

    true
    log_reduce_black_list

    array

    The blacklist for filtering clustering fields in LogReduce. This parameter takes effect only when LogReduce is enabled.

    string

    The blacklist field.

    time
    log_reduce_white_list

    array

    The whitelist for filtering clustering fields in LogReduce. This parameter takes effect only when LogReduce is enabled.

    string

    The whitelist field.

    name
    max_text_len

    integer

    Simple Log Service sets the maximum length of a field value to 2,048 bytes (2 KB) by default. To change the maximum length of a field value, set the maximum length of a statistics field (text). Valid values: 64 to 16384. Unit: bytes.

    2048
    scan_index

    boolean

    Specifies whether to enable scan index. At least one of the following must exist: full-text index, field index, or scan index.

    false