Adding a Quick Search
Function
Adding a Quick Search
URI
POST /v1.0/{project_id}/groups/{group_id}/topics/{topic_id}/search-criterias
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 32 Maximum: 32 |
group_id |
Yes |
String |
ID of the log group whose log streams will be queried. Generally, it contains 36 characters. Minimum: 36 Maximum: 36 |
topic_id |
Yes |
String |
Log stream ID. Minimum: 36 Maximum: 36 |
Request 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. Minimum: 1000 Maximum: 2000 |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. Minimum: 30 Maximum: 30 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
criteria |
Yes |
String |
Quick search field. Enter the statement to be queried. |
eps_id |
No |
String |
Enterprise project ID. |
name |
Yes |
String |
Quick search name, which contains 1 to 64 characters, including only letters, digits, underscores (_), hyphens (-), and periods (.). Do not start with a period or underscore or end with a period. |
search_type |
Yes |
String |
Search type, for example, raw logs. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
id |
String |
Quick search ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
message |
ErrorMessagebody object |
Error message body. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
details |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
message |
ErrorMessagebody object |
Error message body. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
details |
String |
Error message. |
Example Requests
Adding a Quick Search
POST /v1.0/2a473356cca5487f8373be891bffc1cf/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/topics/2b899d46-218c-4f0c-8ace-a36a290a83a0/search-criterias { "name" : "test", "criteria" : "content : 1234567891234567891234567891234567891234567891234567891234567894", "eps_id" : "0", "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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot