Querying All Quick Searches in a Log Group
Function
This API is used to 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
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. No default value. |
group_id |
Yes |
String |
ID of the log group whose log streams will be queried. Generally, it contains 36 characters. No default value. |
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. |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. No default value. |
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 query type. Raw logs: ORIGINALLOG Visualized logs: VISUALIZATION |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
message |
ErrorMessagebody object |
Error message body. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
details |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
message |
ErrorMessagebody object |
Error message body. |
Example Requests
Querying All Quick Searches in a Log Group
/v1.0/2a473356cca5487f8373be891bffc1cf/lts/groups/d1f4240d-5ee2-4e0b-9e2c-e25c7978c001/search-criterias
Example Responses
Status code: 200
Obtained.
{ "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" } }
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 |
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. |
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