Help Center/ Log Tank Service/ API Reference/ APIs/ Quick Search/ Obtaining a Quick Search

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

Online Debugging

CLI Examples

View PDF

Obtaining a Quick Search

Function

This API is used to obtain a quick search.

Calling Method

For details, see Calling APIs.

URI

GET /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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
search_type	No	String	Definition Quick search type. Constraints N/A Range ORIGINALLOG: raw logs VISUALIZATION: visualized logs Default Value N/A

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
search_criterias	Array of GetQuerySearchCriteriasBody objects	Definition Details of quick search.

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

Obtain a quick search.

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

search_type:  
ORIGINALLOG

Example Responses

Status code: 200

The quick search is obtained.

{
  "search_criterias" : [ {
    "criteria" : "content : 1234567891234567891234567891234567891234567891234567891234567894",
    "name" : "Creating a Number",
    "id" : "0eb379f5-f847-4d25-ba89-05967bf1bae3",
    "search_type" : "ORIGINALLOG"
  } ]
}

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.

{
  "error_code" : "LTS.0203",
  "error_msg" : "Internal Server Error"
}

Status Codes

Status Code	Description
200	The quick search is obtained.
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.