Help Center/ Log Tank Service/ API Reference/ APIs/ Quick Search/ Querying All Quick Searches in a Log Group
Updated on 2025-08-21 GMT+08:00

Querying All Quick Searches in a Log Group

Function

Query all quick searches in a log group.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/lts/groups/{group_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

Log group 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

search_criterias

Array of search_criteriasBody objects

Definition

Details of quick search.

Table 4 search_criteriasBody

Parameter

Type

Description

criterias

Array of GetQuerySearchCriteriasBody objects

Definition

Quick search of a single log stream.

log_stream_id

String

Definition

Log stream ID.

Range

N/A

log_stream_name

String

Definition

Log stream name.

Range

N/A

search_type

String

Definition

Quick search type.

Range

  • ORIGINALLOG: raw logs

  • VISUALIZATION: visualized logs

Table 5 GetQuerySearchCriteriasBody

Parameter

Type

Description

criteria

String

Definition

Quick search content. Generally, it is a SQL statement or keyword query statement for visualization.

Range

N/A

name

String

Definition

Quick search name.

Range

N/A

id

String

Definition

Quick search ID.

Range

N/A

search_type

String

Definition

Quick search content. Generally, it is a SQL statement or keyword query statement for visualization.

Range

  • ORIGINALLOG: log search

  • VISUALIZATION: log analysis

  • SEARCHANALYSIS: statistical chart

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

message

ErrorMessagebody object

Definition

Error details.

Table 7 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 8 Response body parameters

Parameter

Type

Description

message

ErrorMessagebody object

Definition

Error details.

Table 9 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

Query all quick searches in a log group.

/v1.0/2a47xxxxxxxxxx7f8373be891bffc1cf/lts/groups/d1f4240d-xxxx-xxxx-xxxx-e25c7978c001/search-criterias

Example Responses

Status code: 200

Query succeeded.

{
  "search_criterias" : [ {
    "criterias" : [ {
      "criteria" : "234",
      "name" : "234",
      "id" : "aee53496-xxxx-xxxx-xxxx-5a83d1aae134",
      "search_type" : "ORIGINALLOG"
    }, {
      "criteria" : "24",
      "name" : "2342",
      "id" : "939c930a-xxxx-xxxx-xxxx-a3040d857ce1",
      "search_type" : "ORIGINALLOG"
    } ],
    "log_stream_id" : "85025a4b-xxxx-xxxx-xxxx-2b6851d84ea2",
    "log_stream_name" : "lts-test-topic",
    "search_type" : "ORIGINALLOG"
  } ]
}

Status code: 400

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

{
  "message" : {
    "code" : "LTS.0201",
    "details" : "The log group 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.

 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
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 ListQueryAllSearchCriteriasSolution {

    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();
        ListQueryAllSearchCriteriasRequest request = new ListQueryAllSearchCriteriasRequest();
        request.withGroupId("{group_id}");
        try {
            ListQueryAllSearchCriteriasResponse response = client.listQueryAllSearchCriterias(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
# 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 = ListQueryAllSearchCriteriasRequest()
        request.group_id = "{group_id}"
        response = client.list_query_all_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
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.ListQueryAllSearchCriteriasRequest{}
	request.GroupId = "{group_id}"
	response, err := client.ListQueryAllSearchCriterias(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

200

Query succeeded.

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.