更新时间:2025-08-07 GMT+08:00
分享

添加快速查询

功能介绍

添加快速查询。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/groups/{group_id}/topics/{topic_id}/search-criterias

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

group_id

String

参数解释:

待查询日志流所在的日志组ID,获取方式请参见:获取日志组ID和日志流ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

topic_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

criteria

String

参数解释:

快速查询语句。搜索日志时需要重复使用的关键字,例如:“error*”。

约束限制:

不涉及。

取值范围:

长度不能超过128个字符。

默认取值:

不涉及。

eps_id

String

参数解释:

企业项目ID。获取方式请参见:获取企业项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

default

name

String

参数解释:

快速查询名称。

约束限制:

  • 只支持输入英文、数字、中文、中划线、下划线及小数点。

  • 不能以小数点、下划线开头或以小数点结尾。

  • 长度为1-64个字符。

取值范围:

不涉及。

默认取值:

不涉及。

search_type

String

参数解释:

快速查询类型。

约束限制:

不涉及。

取值范围:

  • ORIGINALLOG:原始日志。

  • VISUALIZATION:可视化日志。

默认取值:

不涉及。

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

快速查询ID。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

message

ErrorMessagebody object

参数解释:

错误信息详情。

表6 ErrorMessagebody

参数

参数类型

描述

code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

details

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

message

ErrorMessagebody object

参数解释:

错误信息详情。

表8 ErrorMessagebody

参数

参数类型

描述

code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

details

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

请求示例

添加快速查询。

/v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias

{
  "name" : "创建数字",
  "criteria" : "content : 1234567891234567891234567891234567891234567891234567891234567894",
  "eps_id" : "0",
  "search_type" : "ORIGINALLOG"
}

响应示例

状态码:201

添加快速查询成功。

{
  "id" : "0eb379f5-f847-4d25-ba89-05967bf1bae3"
}

状态码:400

非法请求,建议根据error_msg直接修改该请求

{
  "message" : {
    "code" : "LTS.0208",
    "details" : "The log stream does not existed"
  }
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错。

{
  "message" : {
    "code" : "LTS.0203",
    "details" : "Internal Server Error"
  }
}

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
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.*;


public class CreateSearchCriteriasSolution {

    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();
        CreateSearchCriteriasRequest request = new CreateSearchCriteriasRequest();
        request.withGroupId("{group_id}");
        request.withTopicId("{topic_id}");
        CreateSearchCriteriasBody body = new CreateSearchCriteriasBody();
        body.withSearchType("ORIGINALLOG");
        body.withName("创建数字");
        body.withEpsId("0");
        body.withCriteria("content : 1234567891234567891234567891234567891234567891234567891234567894");
        request.withBody(body);
        try {
            CreateSearchCriteriasResponse response = client.createSearchCriterias(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
# 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 = CreateSearchCriteriasRequest()
        request.group_id = "{group_id}"
        request.topic_id = "{topic_id}"
        request.body = CreateSearchCriteriasBody(
            search_type="ORIGINALLOG",
            name="创建数字",
            eps_id="0",
            criteria="content : 1234567891234567891234567891234567891234567891234567891234567894"
        )
        response = client.create_search_criterias(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
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.CreateSearchCriteriasRequest{}
	request.GroupId = "{group_id}"
	request.TopicId = "{topic_id}"
	epsIdCreateSearchCriteriasBody:= "0"
	request.Body = &model.CreateSearchCriteriasBody{
		SearchType: "ORIGINALLOG",
		Name: "创建数字",
		EpsId: &epsIdCreateSearchCriteriasBody,
		Criteria: "content : 1234567891234567891234567891234567891234567891234567891234567894",
	}
	response, err := client.CreateSearchCriterias(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

添加快速查询成功。

400

非法请求,建议根据error_msg直接修改该请求

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码

相关文档