更新时间:2025-08-20 GMT+08:00

创建日志流索引

功能介绍

创建日志流索引。支持全文索引和字段索引,通过配置索引,可对日志进行查询和分析操作,提升日志检索效率。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/groups/{group_id}/stream/{stream_id}/index/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

group_id

String

参数解释:

日志组ID,获取方式请参见:获取日志组ID和日志流ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

stream_id

String

参数解释:

日志流ID,获取方式请参见:获取日志组ID和日志流ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

logStreamId

String

参数解释:

日志流ID,获取方式请参见:获取日志组ID和日志流ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

fullTextIndex

LTSFullTextIndexInfo object

参数解释:

全文索引配置相关信息。

约束限制:

不涉及。

fields

Array of LTSFieldsInfo objects

参数解释:

字段索引配置相关信息。

约束限制:

不涉及。

sqlAnalysisEnable

Boolean

参数解释:

是否开启日志分析。

约束限制:

不涉及。

取值范围:

true:开启日志分析。

false:不开启日志分析。

默认取值:

true

fastAnalysisSampleCount

Long

参数解释:

快速分析采样日志条数。

约束限制:

不涉及。

取值范围:

最小值:100000

最大值:10000000

默认取值:

100000

表4 LTSFullTextIndexInfo

参数

是否必选

参数类型

描述

enable

Boolean

参数解释:

是否开启全文索引配置。

约束限制:

不涉及。

取值范围:

true:开启全文索引配置。

false:不开启全文索引配置。

默认取值:

true

caseSensitive

Boolean

参数解释:

开启全文索引配置时,是否区分英文字母的大小写。

约束限制:

不涉及。

取值范围:

true:区分英文字母大小写。

false:不区分英文字母大小写。

默认取值:

false

includeChinese

Boolean

参数解释:

开启全文索引配置时,是否包含中文。

约束限制:

不涉及。

取值范围:

true:包含中文。

false:不包含中文。

默认取值:

false

tokenizer

String

参数解释:

分词符。根据指定分词符,将日志内容拆分成多个词;当默认设置不能满足需求时,可以自定义设置分词符。

约束限制:

不涉及。

取值范围:

最小长度:0

最大长度:128

默认取值:

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

ascii

Array of strings

参数解释:

特殊分词符,参考ASCII码对照表输入ASCII值和控制字符。

约束限制:

不涉及。

取值范围:

最小长度:1

最大长度:3

默认取值:

不涉及。

表5 LTSFieldsInfo

参数

是否必选

参数类型

描述

fieldType

String

参数解释:

字段索引配置时,日志的字段类型。

约束限制:

不涉及。

取值范围:

  • string

  • long

  • float

  • json

默认取值:

string

fieldName

String

参数解释:

字段索引配置时,日志的字段名称。

约束限制:

  • 只支持输入英文、数字、中划线、下划线及小数点,不能以小数点开头或结尾且不能以双下线结尾。

  • 日志服务默认会对部分内置保留字段开启字段索引,请参见内置保留字段。

取值范围:

示例日志中的字段。

默认取值:

不涉及。

caseSensitive

Boolean

参数解释:

字段索引配置时,是否开启大小写。

约束限制:

不涉及。

取值范围:

  • true:开启大小写。

  • false:不开启大小写。

默认取值:

false

includeChinese

Boolean

参数解释:

字段索引配置时,是否包含中文。

约束限制:

不涉及。

取值范围:

  • true:包含中文。

  • false:不包含中文。

默认取值:

false

tokenizer

String

参数解释:

自定义分词符。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

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

quickAnalysis

Boolean

参数解释:

字段索引配置时,是否开启快速分析。

约束限制:

  • 快速分析的字段长度最大为2000字节。

  • 快速分析字段展示前100条数据。

  • true:开启快速分析。

  • false:不开启快速分析。

取值范围:

默认取值:

true

ascii

Array of strings

参数解释:

特殊分词符。

约束限制:

不涉及。

ltsSubFieldsInfoList

Array of LTSSubFieldsInfo objects

参数解释:

字段索引配置中字段类型为json时的字段信息。

约束限制:

不涉及。

fieldAnalysisAlias

String

参数解释:

别名,设置别名后,只支持使用别名进行SQL搜索分析,不支持使用别名进行关键字搜索。

约束限制:

不涉及。

取值范围:

长度不能大于256。

默认取值:

不涉及。

表6 LTSSubFieldsInfo

参数

是否必选

参数类型

描述

fieldType

String

参数解释:

字段索引配置时,日志的字段类型。

约束限制:

不涉及。

取值范围:

  • string

  • long

  • float

默认取值:

string

fieldName

String

参数解释:

字段索引配置时,日志的字段名称。

约束限制:

  • 只支持输入英文、数字、中划线、下划线及小数点,不能以小数点开头或结尾且不能以双下线结尾。

  • 日志服务默认会对部分内置保留字段开启字段索引,请参见内置保留字段。

取值范围:

示例日志中的字段。

默认取值:

不涉及。

quickAnalysis

Boolean

参数解释:

字段索引配置时,是否开启快速分析。

约束限制:

  • 快速分析的字段长度最大为2000字节。

  • 快速分析字段展示前100条数据。

  • true:开启快速分析。

  • false:不开启快速分析。

取值范围:

默认取值:

true

fieldAnalysisAlias

String

参数解释:

别名,设置别名后,只支持使用别名进行SQL搜索分析,不支持使用别名进行关键字搜索。

约束限制:

不涉及。

取值范围:

长度不能大于256。

默认取值:

不涉及。

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

errorCode

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

errorMessage

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

result

String

参数解释:

日志流ID。

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

errorCode

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

errorMessage

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:401

表9 响应Body参数

参数

参数类型

描述

errorCode

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

errorMessage

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:500

表10 响应Body参数

参数

参数类型

描述

errorCode

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

errorMessage

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

请求示例

该接口用于向指定日志流创建索引。

POST https://{endpoint}/v1.0/{project_id}/groups/{group_id}/stream/{stream_id}/index/config

{
  "logStreamId" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "fullTextIndex" : {
    "enable" : true,
    "caseSensitive" : false,
    "includeChinese" : true,
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r"
  },
  "fields" : [ {
    "fieldType" : "long",
    "fieldName" : "fieldName1",
    "caseSensitive" : false,
    "includeChinese" : true,
    "tokenizer" : "",
    "quickAnalysis" : true
  }, {
    "fieldType" : "string",
    "fieldName" : "fieldName2",
    "caseSensitive" : false,
    "includeChinese" : true,
    "tokenizer" : "",
    "quickAnalysis" : true
  } ]
}

响应示例

状态码:200

添加索引配置成功。

{
  "errorCode" : "SVCSTG.ALS.200200",
  "errorMessage" : "add or update indexConfig successfully",
  "result" : "493d04ce-5130-4b07-88be-c5ae3b50bccb"
}

状态码:400

请求参数错误,请根据响应体内容进行修改。

{
  "errorCode" : "SVCSTG.ALS.200201",
  "errorMessage" : "IndexConfigInfo check failed.",
  "isQueryComplete" : true
}

状态码:401

认证鉴权失败,排查认证信息是否过期。

{
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail",
  "error_code" : "APIGW.0301",
  "request_id" : "b16cc9d789f34cd5196d8df065341788"
}

状态码:500

表示服务后端已经接收到请求,但服务内部处理错误。

{
  "highLightFields" : { },
  "errorCode" : "LTS.0203",
  "errorMessage" : "Internal Server Error",
  "result" : null,
  "encoded_authorization_message" : null,
  "isQueryComplete" : true
}

SDK代码示例

SDK代码示例如下。

该接口用于向指定日志流创建索引。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateLogStreamIndexSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateLogStreamIndexRequest request = new CreateLogStreamIndexRequest();
        request.withGroupId("{group_id}");
        request.withStreamId("{stream_id}");
        LTSIndexConfigInfo body = new LTSIndexConfigInfo();
        List<LTSFieldsInfo> listbodyFields = new ArrayList<>();
        listbodyFields.add(
            new LTSFieldsInfo()
                .withFieldType(LTSFieldsInfo.FieldTypeEnum.fromValue("long"))
                .withFieldName("fieldName1")
                .withCaseSensitive(false)
                .withIncludeChinese(true)
                .withTokenizer("")
                .withQuickAnalysis(true)
        );
        listbodyFields.add(
            new LTSFieldsInfo()
                .withFieldType(LTSFieldsInfo.FieldTypeEnum.fromValue("string"))
                .withFieldName("fieldName2")
                .withCaseSensitive(false)
                .withIncludeChinese(true)
                .withTokenizer("")
                .withQuickAnalysis(true)
        );
        LTSFullTextIndexInfo fullTextIndexbody = new LTSFullTextIndexInfo();
        fullTextIndexbody.withEnable(true)
            .withCaseSensitive(false)
            .withIncludeChinese(true)
            .withTokenizer(", '";=()[]{}@&<>/:\n\t\r");
        body.withLogStreamId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
        body.withFields(listbodyFields);
        body.withFullTextIndex(fullTextIndexbody);
        request.withBody(body);
        try {
            CreateLogStreamIndexResponse response = client.createLogStreamIndex(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

该接口用于向指定日志流创建索引。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateLogStreamIndexRequest()
        request.group_id = "{group_id}"
        request.stream_id = "{stream_id}"
        listFieldsbody = [
            LTSFieldsInfo(
                field_type="long",
                field_name="fieldName1",
                case_sensitive=False,
                include_chinese=True,
                tokenizer="",
                quick_analysis=True
            ),
            LTSFieldsInfo(
                field_type="string",
                field_name="fieldName2",
                case_sensitive=False,
                include_chinese=True,
                tokenizer="",
                quick_analysis=True
            )
        ]
        fullTextIndexbody = LTSFullTextIndexInfo(
            enable=True,
            case_sensitive=False,
            include_chinese=True,
            tokenizer=", '";=()[]{}@&<>/:\n\t\r"
        )
        request.body = LTSIndexConfigInfo(
            log_stream_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            fields=listFieldsbody,
            full_text_index=fullTextIndexbody
        )
        response = client.create_log_stream_index(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

该接口用于向指定日志流创建索引。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateLogStreamIndexRequest{}
	request.GroupId = "{group_id}"
	request.StreamId = "{stream_id}"
	caseSensitiveFields:= false
	includeChineseFields:= true
	quickAnalysisFields:= true
	caseSensitiveFields1:= false
	includeChineseFields1:= true
	quickAnalysisFields1:= true
	var listFieldsbody = []model.LtsFieldsInfo{
        {
            FieldType: model.GetLtsFieldsInfoFieldTypeEnum().LONG,
            FieldName: "fieldName1",
            CaseSensitive: &caseSensitiveFields,
            IncludeChinese: &includeChineseFields,
            Tokenizer: "",
            QuickAnalysis: &quickAnalysisFields,
        },
        {
            FieldType: model.GetLtsFieldsInfoFieldTypeEnum().STRING,
            FieldName: "fieldName2",
            CaseSensitive: &caseSensitiveFields1,
            IncludeChinese: &includeChineseFields1,
            Tokenizer: "",
            QuickAnalysis: &quickAnalysisFields1,
        },
    }
	fullTextIndexbody := &model.LtsFullTextIndexInfo{
		Enable: true,
		CaseSensitive: false,
		IncludeChinese: true,
		Tokenizer: ", '";=()[]{}@&<>/:\n\t\r",
	}
	request.Body = &model.LtsIndexConfigInfo{
		LogStreamId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		Fields: &listFieldsbody,
		FullTextIndex: fullTextIndexbody,
	}
	response, err := client.CreateLogStreamIndex(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

添加索引配置成功。

400

请求参数错误,请根据响应体内容进行修改。

401

认证鉴权失败,排查认证信息是否过期。

500

表示服务后端已经接收到请求,但服务内部处理错误。

错误码

请参见错误码