Querying a Structuring Rule
Function
This API is used to query the structuring rule of a specified log stream.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/lts/struct/template
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. Default: None Minimum: 32 Maximum: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
log_group_id |
Yes |
String |
Log group ID. For details about how to obtain a log group ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. No default value. Minimum: 36 Maximum: 36 |
log_stream_id |
Yes |
String |
Log stream ID. For details about how to obtain a log stream ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. No default value. 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. Default: None Minimum: 1000 Maximum: 2000 |
Content-Type |
Yes |
String |
Set this parameter to application/json;charset=UTF-8. Default: None Minimum: 30 Maximum: 30 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
demoFields |
Array of StructFieldInfoReturn objects |
Structured field. |
tagFields |
Array of tag_fields_info objects |
Keyword details. |
demoLog |
String |
Sample log event. |
demoLabel |
String |
Attributes of the sample log event. |
id |
String |
Structuring rule ID. |
logGroupId |
String |
Log group ID. |
rule |
ShowStructTemplateRule object |
Structuring method. |
cluster_info |
Kafka information. |
|
logStreamId |
String |
Log stream ID. |
projectId |
String |
Project ID. |
templateName |
String |
Template name. |
regex |
String |
Regular expression. |
Parameter |
Type |
Description |
---|---|---|
fieldName |
String |
Field name. |
type |
String |
Field data type. |
content |
String |
Field content. |
isAnalysis |
Boolean |
Whether parsing is enabled. |
index |
Integer |
Field sequence number. |
Parameter |
Type |
Description |
---|---|---|
fieldName |
String |
Metric |
type |
String |
Type |
content |
String |
Content |
isAnalysis |
Boolean |
Whether parsing is enabled. |
index |
Integer |
Field sequence number. |
Parameter |
Type |
Description |
---|---|---|
param |
String |
Structuring parameter. |
type |
String |
Structuring type. |
Parameter |
Type |
Description |
---|---|---|
cluster_name |
String |
Kafka cluster name. |
kafka_bootstrap_servers |
String |
Kafka cluster server address. |
kafka_ssl_enable |
Boolean |
Whether SSL encrypted authentication is enabled for Kafka. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumeration values:
|
error_msg |
String |
Error message. Enumeration values:
|
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumeration values:
|
error_msg |
String |
Error message. Enumeration values:
|
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumeration values:
|
error_msg |
String |
Error message. Enumeration values:
|
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Enumeration values:
|
error_msg |
String |
Error message. Enumeration values:
|
Example Requests
Query the structuring rule of a specified log stream. The request parameter is same as the path parameter. No request example is provided.
Example Responses
Status code: 200
Details of the structuring rule are returned.
{ "demoFields" : [ { "content" : "100.19.10.178", "fieldName" : "authority", "index" : 0, "isAnalysis" : true, "type" : "string" }, { "content" : "0", "fieldName" : "bytes_received", "index" : 0, "isAnalysis" : true, "type" : "string" }, { "content" : "1127", "fieldName" : "bytes_sent", "index" : 0, "isAnalysis" : true, "type" : "string" } ] }
Status code: 400
Bad Request: The request is invalid. Modify the request based on the description in error_msg before a retry.
{ "errorCode" : "SVCSTG.ALS.200201", "errorMessage" : "Query Param is error." }
Status code: 401
AuthFailed. Authentication failed. Check the token and try again.
{ "error_code" : "LTS.0414", "error_msg" : "Invalid token" }
Status code: 403
Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
{ "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" }
Status code: 500
InternalServerError. The server has received the request but encountered an internal error.
{ "error_code" : "LTS.0102", "error_msg" : "Query empty." }
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 |
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 ShowStructTemplateSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("<YOUR REGION>")) .build(); ShowStructTemplateRequest request = new ShowStructTemplateRequest(); try { ShowStructTemplateResponse response = client.showStructTemplate(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 |
# 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"] credentials = BasicCredentials(ak, sk) client = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowStructTemplateRequest() response = client.show_struct_template(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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := lts.NewLtsClient( lts.LtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowStructTemplateRequest{} response, err := client.ShowStructTemplate(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 |
Details of the structuring rule are returned. |
400 |
Bad Request: The request is invalid. Modify the request based on the description in error_msg before a retry. |
401 |
AuthFailed. Authentication failed. Check the token and try again. |
403 |
Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications. |
500 |
InternalServerError. The server has received the request but encountered an internal error. |
503 |
ServiceUnavailable. The requested service is unavailable. |
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