Querying All Quick Searches in a Log Group
Function
Query all quick searches in a log group.
URI
GET /v1.0/{project_id}/lts/groups/{group_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 Account ID, Project ID, Log Group ID, and Log Stream ID. Default value: None. Minimum length: 32 characters. Maximum length: 32 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. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
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 |
No |
String |
Set this parameter to application/json;charset=UTF-8. Default value: None. Minimum length: 30 characters. Maximum length: 30 characters. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
search_criterias |
Array of search_criteriasBody objects |
Quick Search |
Parameter |
Type |
Description |
---|---|---|
criterias |
Array of GetQuerySearchCriteriasBody objects |
Quick search of a single log stream. |
log_stream_id |
String |
Log stream ID. |
log_stream_name |
String |
Log stream name. |
Parameter |
Type |
Description |
---|---|---|
criteria |
String |
Quick search of a field. |
name |
String |
Quick search of a name. |
id |
String |
Quick search ID. |
search_type |
String |
Quick search type. Raw log: ORIGINALLOG Visual log: VISUALIZATION |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
message |
ErrorMessagebody object |
Error message body. |
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
Parameter |
Type |
Description |
---|---|---|
message |
ErrorMessagebody object |
Error message body. |
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/lts/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/search-criterias
Example Responses
Status code: 200
Query succeeded.
{ "search_criterias" : [ { "criterias" : [ ], "log_stream_id" : "c0e668bd-32eb-428d-8d9b-8ff9e17b054e", "log_stream_name" : "lts-topic-lqd API cs" }, { "criterias" : [ ], "log_stream_id" : "e142ef8e-0702-4a6f-abb0-172e0eaf8f36", "log_stream_name" : "lts-urltwo URL" }, { "criterias" : [ ], "log_stream_id" : "99e2b128-1771-4678-83c0-0d14410ffcf1", "log_stream_name" : "lts-lts01-delegated ingestion" }, { "criterias" : [ ], "log_stream_id" : "d2a3ed40-8dba-4538-9522-6e6455101787", "log_stream_name" : "lts-split-scheduled SQL test" }, { "criterias" : [ ], "log_stream_id" : "774cee72-fc25-4e2d-a2f2-d0379c8605a4", "log_stream_name" : "lts-topic-lqdSQLtest" }, { "criterias" : [ ], "log_stream_id" : "2413e15a-1fa9-47a6-ac50-8be75ca569e6", "log_stream_name" : "lts-topic-lqd600" }, { "criterias" : [ ], "log_stream_id" : "6595c251-18ef-4f97-a5c4-29877eaf8dc3", "log_stream_name" : "lts-topic-JSON" }, { "criterias" : [ ], "log_stream_id" : "eaeb0d3d-89bb-47e4-b6b6-e01bd41af2e0", "log_stream_name" : "lts-TEST-A3" }, { "criterias" : [ ], "log_stream_id" : "1bc454cd-e352-4939-a7a5-f515eee0af85", "log_stream_name" : "lts-duo-numberone" }, { "criterias" : [ ], "log_stream_id" : "2b899d46-218c-4f0c-8ace-a36a290a83a0", "log_stream_name" : "lts-test64 structuring" }, { "criterias" : [ ], "log_stream_id" : "6b78cb81-9199-4463-8445-611dbd088e72", "log_stream_name" : "lts-urlip port" }, { "criterias" : [ { "criteria" : "content : this", "name" : "testCreate", "id" : "6be3877c-66d0-4189-b05c-25704a3213b7", "search_type" : "ORIGINALLOG" } ], "log_stream_id" : "f3d853be-0576-4dff-aee9-c093e4924b63", "log_stream_name" : "lts-topic-lqdjiegou" }, { "criterias" : [ ], "log_stream_id" : "60906859-e91e-4d4a-9a21-ae319f544567", "log_stream_name" : "lts-lqd-Nginxshili" } ] }
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" } }
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.
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