ALIYUN::SLS::Index

更新时间:2025-01-08 02:52:44

ALIYUN::SLS::Index类型用于为指定的日志库创建索引。

语法

{
  "Type": "ALIYUN::SLS::Index",
  "Properties": {
    "ProjectName": String,
    "FullTextIndex": Map,
    "LogstoreName": String,
    "KeyIndices": List,
    "LogReduce": Boolean
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

属性名称

类型

必须

允许更新

描述

约束

ProjectName

String

日志项目名称。

长度为3~63个字符。必须以小写字母或数字开头和结尾,可包含小写字母、数字、短划线(-)和下划线(_)。

FullTextIndex

Map

全文索引配置。

详情请参见FullTextIndex属性

LogstoreName

String

日志库名称。

KeyIndices

List

字段索引配置。

全文索引和字段索引至少配置一个。

详情请参见属性

LogReduce

Boolean

是否启用日志分割。

取值:

  • true:启用日志分割。

  • false(默认值):不启用日志分割。

FullTextIndex语法

"FullTextIndex": {
  "CaseSensitive": Boolean,
  "Delimiter": String,
  "IncludeChinese": Boolean,
  "Enable": Boolean
}

FullTextIndex属性

属性名称

类型

必须

允许更新

描述

约束

属性名称

类型

必须

允许更新

描述

约束

Enable

Boolean

是否启用全文索引。

取值:

  • true(默认值):启用全文索引。

  • false:不启用全文索引。

CaseSensitive

Boolean

是否区分大小写。

取值:

  • true:区分大小写。

  • false(默认值):不区分大小写。

Delimiter

String

分词符。

支持以下特殊字符:

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

IncludeChinese

Boolean

是否包含中文。

取值:

  • true:包含中文。

  • false(默认值):不包含中文。

KeyIndices语法

"KeyIndices": [
  {
    "Name": String,
    "EnableAnalytics": Boolean,
    "Delimiter": String,
    "CaseSensitive": Boolean,
    "JsonKeyIndices": List,
    "Alias": String,
    "IncludeChinese": String,
    "Type": String
  }
]

KeyIndices属性

属性名称

类型

必须

允许更新

描述

约束

属性名称

类型

必须

允许更新

描述

约束

Name

String

字段名。

可以使用嵌套名,以英文句点(.)分隔,例如:k1.k2.k3。

EnableAnalytics

Boolean

该字段是否开启统计。

取值:

  • true(默认值):开启统计。

  • false:不开启统计。

Delimiter

String

分词符。

支持以下特殊字符:

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

CaseSensitive

Boolean

是否区分大小写。

取值:

  • true:区分大小写。

  • false(默认值):不区分大小写。

只有当Type参数取值为textjson时该参数生效。

JsonKeyIndices

List

JSON索引配置。格式:[{"key1": "value1", "key2": "value2", ...}]

支持的key为:Name、Alias、TypeEnableAnalytics。

详情请参见JsonKeyIndices属性

Alias

String

字段别名。

IncludeChinese

Boolean

是否包含中文。

取值:

  • true:包含中文。

  • false(默认值):不包含中文。

只有当Type参数取值为text时该参数生效。

Type

String

字段类型。

取值:

  • text(默认值)

  • long

  • double

  • json

JsonKeyIndices语法

"JsonKeyIndices": [
  {
    "Type": String,
    "Alias": String,
    "EnableAnalytics": Boolean,
    "Name": String
  }
]  

JsonKeyIndices属性

属性名称

类型

必须

允许更新

描述

约束

属性名称

类型

必须

允许更新

描述

约束

Name

String

字段名。

EnableAnalytics

Boolean

是否支持查询分析。

取值:

  • true:支持查询分析。

  • false:不支持查询分析。

Alias

String

字段别名。

Type

String

字段类型。

返回值

Fn::GetAtt

无。

示例

YAML
JSON
ROSTemplateFormatVersion: '2015-09-01'
Description: Test SLS Index
Parameters: {}
Resources:
  LogIndex:
    Type: ALIYUN::SLS::Index
    Properties:
      ProjectName: TestProject
      FullTextIndex:
        CaseSensitive: true
      LogstoreName: TestLogstore
Outputs: {}          
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test SLS Index",
  "Parameters": {
  },
  "Resources": {
    "LogIndex": {
      "Type": "ALIYUN::SLS::Index",
      "Properties": {
        "ProjectName": "TestProject",
        "FullTextIndex": {
          "CaseSensitive": true
        },
        "LogstoreName": "TestLogstore"
      }
    }
  },
  "Outputs": {
  }
}
  • 本页导读 (1)
  • 语法
  • 属性
  • FullTextIndex语法
  • FullTextIndex属性
  • KeyIndices语法
  • KeyIndices属性
  • JsonKeyIndices语法
  • JsonKeyIndices属性
  • 返回值
  • 示例