查询结构化配置
功能介绍
该接口用于查询指定日志流下的结构化配置内容。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/lts/struct/template
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
logGroupId |
是 |
String |
日志组ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None |
logStreamId |
是 |
String |
日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
demoFields |
Array of StructFieldInfoReturn objects |
结构化字段 |
tagFields |
Array of tag_fields_info objects |
关键词详细信息 |
demoLog |
String |
示例日志 |
demoLabel |
String |
参考日志属性 |
id |
String |
结构化配置id |
logGroupId |
String |
日志组ID |
rule |
ShowStructTemplateRule object |
结构化方式 |
cluster_info |
kafka信息 |
|
logStreamId |
String |
日志流ID |
projectId |
String |
项目ID |
templateName |
String |
模板名称 |
regex |
String |
正则表达式 |
参数 |
参数类型 |
描述 |
---|---|---|
fieldName |
String |
字段名称 |
type |
String |
字段数据类型 |
content |
String |
字段内容 |
isAnalysis |
Boolean |
是否解析 |
index |
Integer |
字段序号 |
参数 |
参数类型 |
描述 |
---|---|---|
fieldName |
String |
字段名称 |
type |
String |
字段类型 |
content |
String |
内容 |
isAnalysis |
Boolean |
是否解析 |
index |
Integer |
字段序号 |
参数 |
参数类型 |
描述 |
---|---|---|
cluster_name |
String |
kafka集群名称 |
kafka_bootstrap_servers |
String |
kafka集群的服务器地址 |
kafka_ssl_enable |
Boolean |
kafka是否开启ssl加密认证 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
请求示例
查询当前租户下指定日志流下的结构化配置内容。请求参数为路径参数,不提供请求示例。
响应示例
状态码: 200
请求响应成功, 成功获取结构化配置。
{ "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" } ] }
状态码: 400
BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。
{ "errorCode" : "SVCSTG.ALS.200201", "errorMessage" : "Query Param is error." }
状态码: 401
AuthFailed。鉴权失败, 请确认token后再次请求 。
{ "error_code" : "LTS.0414", "error_msg" : "Invalid token" }
状态码: 403
Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" }
状态码: 500
InternalServerError。
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.0102", "error_msg" : "Query empty." }
SDK代码示例
SDK代码示例如下。
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 |
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"); 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(); 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 31 |
# 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 = 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 36 37 |
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.ShowStructTemplateRequest{} response, err := client.ShowStructTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功, 成功获取结构化配置。 |
400 |
BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 |
401 |
AuthFailed。鉴权失败, 请确认token后再次请求 。 |
403 |
Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 |
503 |
ServiceUnavailable。 被请求的服务无效, 服务不可用。 |
错误码
请参见错误码。