全部產品
Search
文件中心

Resource Orchestration Service:ALIYUN::SLS::Index

更新時間:Jan 09, 2025

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、Type和EnableAnalytics。

詳情請參見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

無。

樣本

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": {
  }
}