Updated on 2025-08-21 GMT+08:00

Adding a Quick Search

Function

This API is used to add a quick search.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

group_id

Yes

String

Definition

ID of the log group to which the log stream to be queried belongs. For details about how to obtain it, see Obtaining Log Group and Log Stream IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

topic_id

Yes

String

Definition

Log stream ID. For details about how to obtain it, see Obtaining Log Group and Log Stream IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Message body format. Set this parameter to application/json;charset=utf8.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

criteria

Yes

String

Definition

Quick search statement. Keyword that needs to be repeatedly used during log search, for example, error*.

Constraints

N/A

Range

A maximum of 128 characters is allowed.

Default Value

N/A

eps_id

No

String

Definition

Enterprise project ID. For details about how to obtain it, see Obtaining an Enterprise Project ID.

Constraints

N/A

Range

N/A

Default Value

default

name

Yes

String

Definition

Quick search name.

Constraints

  • Use only letters, digits, hyphens (-), underscores (_), and periods (.).

  • Do not start with a period (.) or underscore (_), or end with a period (.).

  • Enter 1 to 64 characters.

Range

N/A

Default Value

N/A

search_type

Yes

String

Definition

Quick search type.

Constraints

N/A

Range

  • ORIGINALLOG: raw logs

  • VISUALIZATION: visualized logs

Default Value

N/A

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition

Quick search ID.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

message

ErrorMessagebody object

Definition

Error details.

Table 6 ErrorMessagebody

Parameter

Type

Description

code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

details

String

Definition

Error message.

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

message

ErrorMessagebody object

Definition

Error details.

Table 8 ErrorMessagebody

Parameter

Type

Description

code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

details

String

Definition

Error message.

Range

N/A

Example Requests

Add a quick search.

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

{
  "name" : "Creating a Number",
  "criteria" : "content : 1234567891234567891234567891234567891234567891234567891234567894",
  "eps_id" : "0",
  "search_type" : "ORIGINALLOG"
}

Example Responses

Status code: 201

The quick search is added.

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

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

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

Status code: 500

The server has received the request but encountered an internal error.

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

SDK Sample Code

The SDK sample code is as follows.

Add a quick search.

 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("Creating a Number");
        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());
        }
    }
}

Add a quick search.

 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="Creating a Number",
            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)

Add a quick search.

 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: "Creating a Number",
		EpsId: &epsIdCreateSearchCriteriasBody,
		Criteria: "content : 1234567891234567891234567891234567891234567891234567891234567894",
	}
	response, err := client.CreateSearchCriterias(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

The quick search is added.

400

Invalid request. Modify the request based on the description in error_msg before a retry.

500

The server has received the request but encountered an internal error.

Error Codes

See Error Codes.