Adding a Quick Search

Function

Add a quick search.

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	Project ID. For details about how to obtain a project ID, see Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID. Minimum length: 1 character. Maximum length: 64 characters.
group_id	Yes	String	ID of the log group whose log streams will be queried. Default value: None. Minimum length: 36 characters. Maximum length: 36 characters.
topic_id	Yes	String	Log stream ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token. Default value: None. Minimum length: 1000 characters. Maximum length: 2000 characters.
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8. Default value: None. Minimum length: 30 characters. Maximum length: 30 characters.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
criteria	Yes	String	Quick search of a field.
name	Yes	String	Create a quick search name.
search_type	No	String	Search type. Raw log: ORIGINALLOG Visual log: VISUALIZATION

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Quick search ID.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
message	ErrorMessagebody object	Error message body.

**Table 6** ErrorMessagebody
Parameter	Type	Description
code	String	Error code. Minimum length: 8 characters. Maximum length: 36 characters.
details	String	Error description. Minimum length: 2 characters. Maximum length: 512 characters.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
message	ErrorMessagebody object	Error message body.

**Table 8** ErrorMessagebody
Parameter	Type	Description
code	String	Error code. Minimum length: 8 characters. Maximum length: 36 characters.
details	String	Error description. Minimum length: 2 characters. Maximum length: 512 characters.

Example Requests

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

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

Example Responses

Status code: 201

Quick search 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"
  }
}

Status Codes

Status Code	Description
201	Quick search 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.