华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_group_name 是 String 需要创建的日志组名称。 配置规则: 名称长度限制为1~64个字符。 名称只能由英文大小写字母、数字、特殊字符“_”“-”“.”组成,且不能以小数点、下划线开头或以小数点结尾。 最小长度:1 最大长度:64 ttl_in_days 是 Integer 日志存储时间(默认为30天)。 最小值:1 最大值:365 tags 否 Array of tagsBody objects 标签字段信息 表4 tagsBody 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值
  • 状态码 状态码 描述 201 请求响应成功, 成功创建日志组。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效, 服务不可用。
  • 响应示例 状态码: 201 请求响应成功, 成功创建日志组。 { "log_group_id" : "b6b9332b-091f-4b22-b810-264318d2d664" } 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0009", "error_msg" : "Failed to validate the request body" } 状态码: 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0003", "error_msg" : "Invalid token" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0102", "error_msg" : "Failed to create log group" }
  • 响应参数 状态码: 201 表5 响应Body参数 参数 参数类型 描述 log_group_id String 创建的日志组的ID。 最小长度:36 最大长度:36 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 响应消息体(可选) 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于“获取用户Token”接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxxxx", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 响应示例 状态码: 200 请求响应成功。 { "results" : [ { "create_time" : 1632897983441, "id" : "47629e46-287d-478c-8888-xxxxxxxxxxxx", "template_name" : "jsonTemplate", "template_type" : "json", "project_id" : "2a473356cca5487f8373be89xxxxxxxx" } ] } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2017", "error_msg" : "Find struct template failed." }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 results Array of BriefStructTemplateModel objects 结构化模板缩略信息列表 表4 BriefStructTemplateModel 参数 参数类型 描述 create_time Long 模板创建/更新时间 最小值:0 最大值:20000000000000 id String 模板id 最小长度:36 最大长度:36 template_name String 模板名称 最小长度:1 最大长度:64 template_type String 结构化类型,当前支regex,json,split,nginx 枚举值: regex json split nginx project_id String 项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID 最小长度:32 最大长度:32 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 枚举值: Internal Server Error
  • 响应示例 状态码: 200 请求响应成功, 成功修改结构化配置。 { "2a473356cca5487f8373be891bffc1cf_8a75b77d-7d72-4d7e-8c50-a24562cf8b0b_fd5e1a7c-7412-475d-a013-8891d539574e" } 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "errorCode" : "LTS.0612", "errorMessage" : "timee fieldType 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" : "Failed to create log group" }
  • 状态码 状态码 描述 200 请求响应成功, 成功修改结构化配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效, 服务不可用。
  • 响应参数 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: SV CS TG.ALS.200201 SVCSTG.ALS.200340 SVCSTG.ALS.200332 SVCSTG.ALS.200209 SVCSTG.ALS.200.339 error_msg String 调用失败响应信息描述。 枚举值: parseType is invalid/ smart extra failed./ The number of demo_fields and rules is not equal {字段名/别名} is repeated with internal fields userDefinedName repeat./ field name repeat check logContent type error nginx log_format is error 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0202 error_msg String 调用失败响应信息描述。 枚举值: Failed to query lts struct log
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_group_id 是 String 日志组ID 缺省值:None 最小长度:36 最大长度:36 log_stream_id 是 String 日志流ID 缺省值:None 最小长度:36 最大长度:36 project_id 是 String 项目ID 缺省值:None 最小长度:32 最大长度:32 content 是 String 填写一条示例日志。 demo_fields 是 Array of DemoFields objects 示例字段列表。 说明: demo_fields中的字段顺序,须和content中的字段顺序保持一致。 最大个数:200 parse_type 是 String 结构化类型参数(json、split、nginx、built_in、custom_regex)。 regex_rules 否 String 正则表达式(使用正则结构化规则时候需要)。 最大长度:5000 layers 否 Integer 最大解析层数(使用JSON方式结构化需要)。 最大值:3 tokenizer 否 String 分隔符(使用分隔符结构化时需要)。 log_format 否 String Nginx配置规则(使用分隔符结构化时需要)。 tag_fields 是 Array of TagField objects tag字段列表(使用tag字段解析时需要,其中系统模板不支持使用tag字段)。 最大个数:200 rule 否 RuleSGQSGQSGQ object 结构化方式 表4 DemoFields 参数 是否必选 参数类型 描述 fieldName 否 String 字段名称 缺省值:None 最小长度:1 最大长度:50 userDefinedName 否 String 自定义别名(json,Nginx方式中按需添加) 缺省值:None 最小长度:1 最大长度:64 type 是 String 字段数据类型。 可选范围:string、long、float isAnalysis 否 Boolean 预留字段。 content 否 String 字段内容。 说明: 在系统模板中,此参数为demoLog。 index 否 Integer 序号 表5 TagField 参数 是否必选 参数类型 描述 fieldName 是 String 字段名称 缺省值:None 最小长度:1 最大长度:50 content 否 String 示例字段。 缺省值:None 最小长度:1 最大长度:64 type 是 String 字段数据类型。可选范围:string、long、float isAnalysis 否 Boolean 预留字段。 表6 RuleSGQSGQSGQ 参数 是否必选 参数类型 描述 type 是 String 内置系统模板类型 param 是 String 系统iton模板名称
  • 响应示例 状态码: 201 请求响应成功。 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.2014", "error_msg" : "template_id is invalid!" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2014", "error_msg" : "Failed to create struct config." }
  • 请求示例 创建 CTS 系统模板 POST https://{endpoint}/v3/{project_id}/lts/struct/template { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "code", "is_analysis" : true }, { "field_name" : "event_type", "is_analysis" : true }, { "field_name" : "project_id", "is_analysis" : true }, { "field_name" : "record_time", "is_analysis" : false }, { "field_name" : "resource_id", "is_analysis" : true }, { "field_name" : "resource_name", "is_analysis" : true }, { "field_name" : "resource_type", "is_analysis" : false }, { "field_name" : "service_type", "is_analysis" : true }, { "field_name" : "source_ip", "is_analysis" : false }, { "field_name" : "time", "is_analysis" : false }, { "field_name" : "trace_id", "is_analysis" : false }, { "field_name" : "trace_name", "is_analysis" : true }, { "field_name" : "trace_rating", "is_analysis" : true }, { "field_name" : "trace_type", "is_analysis" : true }, { "field_name" : "tracker_name", "is_analysis" : true }, { "field_name" : "user.domain.id", "is_analysis" : true }, { "field_name" : "user.domain.name", "is_analysis" : true }, { "field_name" : "user.id", "is_analysis" : true }, { "field_name" : "user.name", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "CTS", "template_id" : "", "quick_analysis" : false } 创建ELB系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "msec", "is_analysis" : false }, { "field_name" : "access_log_topic_id", "is_analysis" : false }, { "field_name" : "time_iso8601", "is_analysis" : false }, { "field_name" : "log_ver", "is_analysis" : true }, { "field_name" : "remote_addr", "is_analysis" : true }, { "field_name" : "remote_port", "is_analysis" : false }, { "field_name" : "status", "is_analysis" : false }, { "field_name" : "request_method", "is_analysis" : false }, { "field_name" : "scheme", "is_analysis" : true }, { "field_name" : "host", "is_analysis" : true }, { "field_name" : "router_request_uri", "is_analysis" : true }, { "field_name" : "server_protocol", "is_analysis" : true }, { "field_name" : "request_length", "is_analysis" : true }, { "field_name" : "bytes_sent", "is_analysis" : false }, { "field_name" : "body_bytes_sent", "is_analysis" : false }, { "field_name" : "request_time", "is_analysis" : false }, { "field_name" : "upstream_status", "is_analysis" : false }, { "field_name" : "upstream_connect_time", "is_analysis" : false }, { "field_name" : "upstream_header_time", "is_analysis" : false }, { "field_name" : "upstream_response_time", "is_analysis" : false }, { "field_name" : "upstream_addr", "is_analysis" : false }, { "field_name" : "http_user_agent", "is_analysis" : false }, { "field_name" : "http_referer", "is_analysis" : false }, { "field_name" : "http_x_forwarded_for", "is_analysis" : false }, { "field_name" : "lb_name", "is_analysis" : false }, { "field_name" : "listener_name", "is_analysis" : false }, { "field_name" : "listener_id", "is_analysis" : false }, { "field_name" : "pool_name", "is_analysis" : false }, { "field_name" : "member_name", "is_analysis" : false }, { "field_name" : "tenant_id", "is_analysis" : false }, { "field_name" : "eip_address", "is_analysis" : false }, { "field_name" : "eip_port", "is_analysis" : false }, { "field_name" : "upstream_addr_priv", "is_analysis" : false }, { "field_name" : "certificate_id", "is_analysis" : false }, { "field_name" : "ssl_protocol", "is_analysis" : false }, { "field_name" : "ssl_cipher", "is_analysis" : false }, { "field_name" : "sni_domain_name", "is_analysis" : false }, { "field_name" : "tcpinfo_rtt", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "ELB", "template_id" : "", "quick_analysis" : false } 创建自定义模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "date", "is_analysis" : true }, { "field_name" : "num", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "custom", "template_name" : "regexTemplate", "template_id" : "47629e46-287d-478c-8888-xxxxxxxxxxxx", "quick_analysis" : false } 创建VPC系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "version", "is_analysis" : false }, { "field_name" : "project_id", "is_analysis" : true }, { "field_name" : "interface_id", "is_analysis" : false }, { "field_name" : "srcaddr", "is_analysis" : true }, { "field_name" : "dstaddr", "is_analysis" : true }, { "field_name" : "srcport", "is_analysis" : false }, { "field_name" : "dstport", "is_analysis" : false }, { "field_name" : "protocol", "is_analysis" : false }, { "field_name" : "packets", "is_analysis" : false }, { "field_name" : "bytes", "is_analysis" : false }, { "field_name" : "start", "is_analysis" : false }, { "field_name" : "end", "is_analysis" : false }, { "field_name" : "action", "is_analysis" : true }, { "field_name" : "log_status", "is_analysis" : true } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "VPC", "template_id" : "", "quick_analysis" : false } 创建APIG系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "my_remote_addr", "is_analysis" : false }, { "field_name" : "request_id", "is_analysis" : false }, { "field_name" : "api_id", "is_analysis" : false }, { "field_name" : "user_name", "is_analysis" : true }, { "field_name" : "app_id", "is_analysis" : true }, { "field_name" : "time_local", "is_analysis" : false }, { "field_name" : "request_time", "is_analysis" : false }, { "field_name" : "request_method", "is_analysis" : false }, { "field_name" : "scheme", "is_analysis" : true }, { "field_name" : "host", "is_analysis" : true }, { "field_name" : "router_uri", "is_analysis" : true }, { "field_name" : "server_protocol", "is_analysis" : true }, { "field_name" : "status", "is_analysis" : true }, { "field_name" : "bytes_sent", "is_analysis" : false }, { "field_name" : "request_length", "is_analysis" : false }, { "field_name" : "http_user_agent", "is_analysis" : false }, { "field_name" : "http_x_forwarded_for", "is_analysis" : false }, { "field_name" : "upstream_addr", "is_analysis" : false }, { "field_name" : "upstream_uri", "is_analysis" : false }, { "field_name" : "upstream_status", "is_analysis" : false }, { "field_name" : "upstream_connect_time", "is_analysis" : false }, { "field_name" : "upstream_header_time", "is_analysis" : false }, { "field_name" : "upstream_response_time", "is_analysis" : false }, { "field_name" : "region_id", "is_analysis" : false }, { "field_name" : "all_upstream_response_time", "is_analysis" : false }, { "field_name" : "errorType", "is_analysis" : false }, { "field_name" : "auth_type", "is_analysis" : false }, { "field_name" : "access_model1", "is_analysis" : false }, { "field_name" : "access_model2", "is_analysis" : false }, { "field_name" : "inner_time", "is_analysis" : false }, { "field_name" : "proxy_protocol_vni", "is_analysis" : false }, { "field_name" : "proxy_protocol_vpce_id", "is_analysis" : false }, { "field_name" : "proxy_protocol_addr", "is_analysis" : false }, { "field_name" : "body_bytes_sent", "is_analysis" : false }, { "field_name" : "api_name", "is_analysis" : false }, { "field_name" : "app_name", "is_analysis" : false }, { "field_name" : "provider_app_id", "is_analysis" : false }, { "field_name" : "provider_app_name", "is_analysis" : false }, { "field_name" : "custom_data_log1", "is_analysis" : false }, { "field_name" : "custom_data_log2", "is_analysis" : false }, { "field_name" : "custom_data_log3", "is_analysis" : false }, { "field_name" : "custom_data_log4", "is_analysis" : false }, { "field_name" : "custom_data_log5", "is_analysis" : false }, { "field_name" : "custom_data_log6", "is_analysis" : false }, { "field_name" : "custom_data_log7", "is_analysis" : false }, { "field_name" : "custom_data_log8", "is_analysis" : false }, { "field_name" : "custom_data_log9", "is_analysis" : false }, { "field_name" : "custom_data_log10", "is_analysis" : false }, { "field_name" : "response_source", "is_analysis" : false }, { "field_name" : "start_time", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "APIG", "template_id" : "", "quick_analysis" : false } 创建DDS系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-000000000000", "log_stream_id" : "b4d56d47-b4c4-453e-9047--000000000000", "demo_fields" : [ { "field_name" : "time", "is_analysis" : false }, { "field_name" : "instance_id", "is_analysis" : false }, { "field_name" : "server_addr", "is_analysis" : false }, { "field_name" : "role", "is_analysis" : false }, { "field_name" : "client_addr", "is_analysis" : false }, { "field_name" : "client_type", "is_analysis" : false }, { "field_name" : "user", "is_analysis" : false }, { "field_name" : "db", "is_analysis" : false }, { "field_name" : "command_name", "is_analysis" : false }, { "field_name" : "command_type", "is_analysis" : false }, { "field_name" : "command_keys", "is_analysis" : false }, { "field_name" : "command_param", "is_analysis" : false }, { "field_name" : "use_time", "is_analysis" : false }, { "field_name" : "extend", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP" } ], "template_type" : "built_in", "template_name" : "DDS_AUDIT", "template_id" : "", "quick_analysis" : false } 创建DDS错误日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "severity", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "raw_message", "is_analysis" : true }, { "field_name" : "instance_id", "is_analysis" : true }, { "field_name" : "node_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "MONGODB_ERROR", "template_id" : "", "quick_analysis" : false } 创建DDS慢日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "namespace", "is_analysis" : false }, { "field_name" : "database", "is_analysis" : true }, { "field_name" : "collection", "is_analysis" : true }, { "field_name" : "operate_type", "is_analysis" : false }, { "field_name" : "docs_scanned", "is_analysis" : false }, { "field_name" : "docs_returned", "is_analysis" : false }, { "field_name" : "n_deleted", "is_analysis" : true }, { "field_name" : "n_matched", "is_analysis" : true }, { "field_name" : "n_modified", "is_analysis" : true }, { "field_name" : "n_inserted", "is_analysis" : true }, { "field_name" : "cost_time", "is_analysis" : true }, { "field_name" : "lock_time", "is_analysis" : false }, { "field_name" : "whole_message", "is_analysis" : false }, { "field_name" : "instance_id", "is_analysis" : false }, { "field_name" : "node_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "MONGODB_SLOW", "template_id" : "", "quick_analysis" : false } 创建GAUSSDB_OPENGAUSS_AUDIT系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-000000000000", "log_stream_id" : "b4d56d47-b4c4-453e-9047--000000000000", "demo_fields" : [ { "field_name" : "username", "is_analysis" : false }, { "field_name" : "client_conninfo", "is_analysis" : false }, { "field_name" : "instanceId", "is_analysis" : false }, { "field_name" : "detail_info", "is_analysis" : false }, { "field_name" : "thread_id", "is_analysis" : false }, { "field_name" : "result", "is_analysis" : false }, { "field_name" : "database", "is_analysis" : false }, { "field_name" : "local_port", "is_analysis" : false }, { "field_name" : "userid", "is_analysis" : false }, { "field_name" : "nodeId", "is_analysis" : false }, { "field_name" : "node_name", "is_analysis" : false }, { "field_name" : "object_name", "is_analysis" : false }, { "field_name" : "time", "is_analysis" : false }, { "field_name" : "type", "is_analysis" : false }, { "field_name" : "remote_port", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP" } ], "template_type" : "built_in", "template_name" : "GAUSSDB_OPENGAUSS_AUDIT", "template_id" : "", "quick_analysis" : false } 创建NGINX系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-000000000000", "log_stream_id" : "b4d56d47-b4c4-453e-9047--000000000000", "demo_fields" : [ { "field_name" : "remote_addr", "is_analysis" : false }, { "field_name" : "remote_user", "is_analysis" : false }, { "field_name" : "time_local", "is_analysis" : false }, { "field_name" : "request_method", "is_analysis" : false }, { "field_name" : "scheme", "is_analysis" : false }, { "field_name" : "host", "is_analysis" : false }, { "field_name" : "request_uri", "is_analysis" : false }, { "field_name" : "server_protocol", "is_analysis" : false }, { "field_name" : "status", "is_analysis" : false }, { "field_name" : "bytes_sent", "is_analysis" : false }, { "field_name" : "body_bytes_sent", "is_analysis" : false }, { "field_name" : "http_referer", "is_analysis" : false }, { "field_name" : "http_user_agent", "is_analysis" : false }, { "field_name" : "http_x_forwarded_for", "is_analysis" : false }, { "field_name" : "request_time", "is_analysis" : false }, { "field_name" : "upstream_response_time", "is_analysis" : false }, { "field_name" : "upstream_addr", "is_analysis" : false }, { "field_name" : "upstream_status", "is_analysis" : false }, { "field_name" : "request_length", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP" } ], "template_type" : "built_in", "template_name" : "NGINX", "template_id" : "", "quick_analysis" : false } 创建TOMCAT系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-000000000000", "log_stream_id" : "b4d56d47-b4c4-453e-9047--000000000000", "demo_fields" : [ { "field_name" : "remote_ip_address", "is_analysis" : false }, { "field_name" : "remote_logical_username", "is_analysis" : false }, { "field_name" : "remote_user_authenticated", "is_analysis" : false }, { "field_name" : "time_local", "is_analysis" : false }, { "field_name" : "scheme", "is_analysis" : false }, { "field_name" : "router_uri", "is_analysis" : false }, { "field_name" : "server_protocol", "is_analysis" : false }, { "field_name" : "status", "is_analysis" : false }, { "field_name" : "bytes_sent", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP" } ], "template_type" : "built_in", "template_name" : "TOMCAT", "template_id" : "", "quick_analysis" : false } 创建DCS审计日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-000000000000", "log_stream_id" : "b4d56d47-b4c4-453e-9047--000000000000", "demo_fields" : [ { "field_name" : "time", "is_analysis" : false }, { "field_name" : "instance_id", "is_analysis" : false }, { "field_name" : "server_addr", "is_analysis" : false }, { "field_name" : "role", "is_analysis" : false }, { "field_name" : "client_addr", "is_analysis" : false }, { "field_name" : "client_type", "is_analysis" : false }, { "field_name" : "user", "is_analysis" : false }, { "field_name" : "db", "is_analysis" : false }, { "field_name" : "command_name", "is_analysis" : false }, { "field_name" : "command_type", "is_analysis" : false }, { "field_name" : "command_keys", "is_analysis" : false }, { "field_name" : "command_param", "is_analysis" : false }, { "field_name" : "use_time", "is_analysis" : false }, { "field_name" : "extend", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP" } ], "template_type" : "built_in", "template_name" : "DCS_AUDIT", "template_id" : "", "quick_analysis" : false } 创建CFW攻击日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "source", "is_analysis" : false }, { "field_name" : "app", "is_analysis" : false }, { "field_name" : "direction", "is_analysis" : false }, { "field_name" : "dst_ip", "is_analysis" : true }, { "field_name" : "src_ip", "is_analysis" : true }, { "field_name" : "event_time", "is_analysis" : false }, { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "dst_port", "is_analysis" : false }, { "field_name" : "attack_rule_id", "is_analysis" : true }, { "field_name" : "index_day", "is_analysis" : true }, { "field_name" : "log_id", "is_analysis" : true }, { "field_name" : "src_port", "is_analysis" : true }, { "field_name" : "protocol", "is_analysis" : true }, { "field_name" : "packet", "is_analysis" : false }, { "field_name" : "level", "is_analysis" : false }, { "field_name" : "attack_type", "is_analysis" : false }, { "field_name" : "fw_instance_id", "is_analysis" : false }, { "field_name" : "action", "is_analysis" : false }, { "field_name" : "vsys", "is_analysis" : false }, { "field_name" : "attack_rule", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "CFW_ATTACK", "template_id" : "", "quick_analysis" : false } 创建CFW访问控制日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "app", "is_analysis" : false }, { "field_name" : "direction", "is_analysis" : false }, { "field_name" : "source-zone", "is_analysis" : false }, { "field_name" : "rule_id", "is_analysis" : true }, { "field_name" : "protocol", "is_analysis" : true }, { "field_name" : "dst_ip", "is_analysis" : false }, { "field_name" : "src_ip", "is_analysis" : false }, { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "hit_time", "is_analysis" : true }, { "field_name" : "log-id", "is_analysis" : true }, { "field_name" : "dst_port", "is_analysis" : true }, { "field_name" : "destination-zone", "is_analysis" : true }, { "field_name" : "index_day", "is_analysis" : true }, { "field_name" : "log_id", "is_analysis" : false }, { "field_name" : "src_port", "is_analysis" : false }, { "field_name" : "fw_instance_id", "is_analysis" : false }, { "field_name" : "action", "is_analysis" : false }, { "field_name" : "vsys", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "CFW_AC CES S", "template_id" : "", "quick_analysis" : false } 创建CFW流量日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "dst_port", "is_analysis" : false }, { "field_name" : "app", "is_analysis" : false }, { "field_name" : "to_c_pkts", "is_analysis" : false }, { "field_name" : "dst_ip", "is_analysis" : true }, { "field_name" : "to_c_bytes", "is_analysis" : true }, { "field_name" : "end_time", "is_analysis" : false }, { "field_name" : "src_ip", "is_analysis" : false }, { "field_name" : "index_day", "is_analysis" : false }, { "field_name" : "bytes", "is_analysis" : true }, { "field_name" : "log-id", "is_analysis" : true }, { "field_name" : "vsys", "is_analysis" : true }, { "field_name" : "suffix", "is_analysis" : true }, { "field_name" : "packets", "is_analysis" : true }, { "field_name" : "direction", "is_analysis" : false }, { "field_name" : "protocol", "is_analysis" : false }, { "field_name" : "to_s_bytes", "is_analysis" : false }, { "field_name" : "to_s_pkts", "is_analysis" : false }, { "field_name" : "src_port", "is_analysis" : false }, { "field_name" : "start_time", "is_analysis" : false }, { "field_name" : "fw_instance_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "CFW_FLOW", "template_id" : "", "quick_analysis" : false } 创建MYSQL错误日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "severity", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "raw_message", "is_analysis" : true }, { "field_name" : "node_id", "is_analysis" : true }, { "field_name" : "instance_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "MYSQL_ERROR", "template_id" : "", "quick_analysis" : false } 创建MYSQL慢日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "start_time", "is_analysis" : false }, { "field_name" : "user", "is_analysis" : false }, { "field_name" : "host", "is_analysis" : false }, { "field_name" : "query_time", "is_analysis" : true }, { "field_name" : "lock_time", "is_analysis" : true }, { "field_name" : "rows_sent", "is_analysis" : false }, { "field_name" : "rows_examined", "is_analysis" : false }, { "field_name" : "command_text", "is_analysis" : false }, { "field_name" : "database", "is_analysis" : true }, { "field_name" : "log_type", "is_analysis" : true }, { "field_name" : "log_time", "is_analysis" : true }, { "field_name" : "operate_type", "is_analysis" : true }, { "field_name" : "node_id", "is_analysis" : true }, { "field_name" : "instance_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "MYSQL_SLOW", "template_id" : "", "quick_analysis" : false } 创建POSTGRESQL慢日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "execute_time", "is_analysis" : false }, { "field_name" : "user", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : true }, { "field_name" : "database", "is_analysis" : true }, { "field_name" : "statement", "is_analysis" : false }, { "field_name" : "host", "is_analysis" : false }, { "field_name" : "log_timestamp", "is_analysis" : false }, { "field_name" : "operate_type", "is_analysis" : true }, { "field_name" : "node_id", "is_analysis" : true }, { "field_name" : "instance_id", "is_analysis" : true } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "POSTGRESQL_SLOW", "template_id" : "", "quick_analysis" : false } 创建POSTGRESQL错误日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "severity", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "raw_message", "is_analysis" : true }, { "field_name" : "node_id", "is_analysis" : true }, { "field_name" : "instance_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "POSTGRESQL_ERROR", "template_id" : "", "quick_analysis" : false } 创建SQLSERVER错误日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-000000000000", "log_stream_id" : "b4d56d47-b4c4-453e-9047--000000000000", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "severity", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "raw_message", "is_analysis" : false }, { "field_name" : "node_id", "is_analysis" : false }, { "field_name" : "instance_id", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP" } ], "template_type" : "built_in", "template_name" : "SQLSERVER_ERROR", "template_id" : "", "quick_analysis" : false } 创建GAUSSDB_REDIS慢日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "instance_id", "is_analysis" : false }, { "field_name" : "node_id", "is_analysis" : false }, { "field_name" : "database", "is_analysis" : false }, { "field_name" : "log_type", "is_analysis" : true }, { "field_name" : "operate_type", "is_analysis" : true }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "cost_time", "is_analysis" : false }, { "field_name" : "whole_message", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "GAUSSDB_REDIS_SLOW", "template_id" : "", "quick_analysis" : false } 创建GAUSSDB_MYSQL慢日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "start_time", "is_analysis" : false }, { "field_name" : "user", "is_analysis" : false }, { "field_name" : "host", "is_analysis" : false }, { "field_name" : "query_time", "is_analysis" : true }, { "field_name" : "lock_time", "is_analysis" : true }, { "field_name" : "rows_sent", "is_analysis" : false }, { "field_name" : "rows_examined", "is_analysis" : false }, { "field_name" : "command_text", "is_analysis" : false }, { "field_name" : "database", "is_analysis" : false }, { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "operate_type", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "GAUSSDB_MYSQL_SLOW", "template_id" : "", "quick_analysis" : false } 创建GAUSSDB_MYSQL错误日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "log_type", "is_analysis" : false }, { "field_name" : "severity", "is_analysis" : false }, { "field_name" : "log_time", "is_analysis" : false }, { "field_name" : "raw_message", "is_analysis" : true } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "GAUSSDB_MYSQL_ERROR", "template_id" : "", "quick_analysis" : false } 创建CDN系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "request_time", "is_analysis" : false }, { "field_name" : "domain", "is_analysis" : false }, { "field_name" : "method", "is_analysis" : false }, { "field_name" : "scheme", "is_analysis" : true }, { "field_name" : "uri", "is_analysis" : true }, { "field_name" : "uri_param", "is_analysis" : false }, { "field_name" : "client_ip", "is_analysis" : false }, { "field_name" : "client_port", "is_analysis" : true }, { "field_name" : "refer_protocol", "is_analysis" : true }, { "field_name" : "refer_domain", "is_analysis" : false }, { "field_name" : "refer_uri", "is_analysis" : true }, { "field_name" : "refer_param", "is_analysis" : true }, { "field_name" : "request_size", "is_analysis" : false }, { "field_name" : "response_time", "is_analysis" : false }, { "field_name" : "response_size", "is_analysis" : true }, { "field_name" : "http_code", "is_analysis" : false }, { "field_name" : "response_range", "is_analysis" : true }, { "field_name" : "request_range", "is_analysis" : false }, { "field_name" : "request_body_bytes", "is_analysis" : true }, { "field_name" : "content_type", "is_analysis" : true }, { "field_name" : "hit_info", "is_analysis" : true }, { "field_name" : "user_agent", "is_analysis" : false }, { "field_name" : "uuid", "is_analysis" : true }, { "field_name" : "via_info", "is_analysis" : true }, { "field_name" : "xforwordfor", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "CDN", "template_id" : "", "quick_analysis" : false } 创建 SMN 系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "message_id", "is_analysis" : false }, { "field_name" : "project_id", "is_analysis" : false }, { "field_name" : "topic_urn", "is_analysis" : false }, { "field_name" : "subscriber_urn", "is_analysis" : true }, { "field_name" : "protocol_name", "is_analysis" : true }, { "field_name" : "endpoint", "is_analysis" : false }, { "field_name" : "status", "is_analysis" : false }, { "field_name" : "http_code", "is_analysis" : true }, { "field_name" : "create_time", "is_analysis" : true }, { "field_name" : "send_time", "is_analysis" : true } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "SMN", "template_id" : "", "quick_analysis" : false } 创建WAF访问日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "response_code", "is_analysis" : false }, { "field_name" : "scheme", "is_analysis" : false }, { "field_name" : "upstream_addr", "is_analysis" : false }, { "field_name" : "body_bytes_sent", "is_analysis" : false }, { "field_name" : "upstream_header_time", "is_analysis" : false }, { "field_name" : "connection_requests", "is_analysis" : false }, { "field_name" : "ssl_cipher", "is_analysis" : false }, { "field_name" : "hostid", "is_analysis" : false }, { "field_name" : "pid", "is_analysis" : false }, { "field_name" : "tls_version", "is_analysis" : false }, { "field_name" : "http_host", "is_analysis" : false }, { "field_name" : "process_time", "is_analysis" : false }, { "field_name" : "access_stream_id", "is_analysis" : false }, { "field_name" : "time_iso8601", "is_analysis" : false }, { "field_name" : "intel_crawler", "is_analysis" : false }, { "field_name" : "upstream_status", "is_analysis" : false }, { "field_name" : "remote_ip", "is_analysis" : false }, { "field_name" : "request_time", "is_analysis" : false }, { "field_name" : "tenantid", "is_analysis" : false }, { "field_name" : "sip", "is_analysis" : false }, { "field_name" : "bytes_send", "is_analysis" : false }, { "field_name" : "projectid", "is_analysis" : false }, { "field_name" : "user_agent", "is_analysis" : false }, { "field_name" : "web_tag", "is_analysis" : false }, { "field_name" : "method", "is_analysis" : false }, { "field_name" : "bind_ip", "is_analysis" : false }, { "field_name" : "region_id", "is_analysis" : false }, { "field_name" : "remote_port", "is_analysis" : false }, { "field_name" : "ssl_ciphers_md5", "is_analysis" : false }, { "field_name" : "x_real_ip", "is_analysis" : false }, { "field_name" : "url", "is_analysis" : false }, { "field_name" : "x_forwarded_for", "is_analysis" : false }, { "field_name" : "sni", "is_analysis" : false }, { "field_name" : "args", "is_analysis" : false }, { "field_name" : "cdn_src_ip", "is_analysis" : false }, { "field_name" : "enterprise_project_id", "is_analysis" : false }, { "field_name" : "upstream_connect_time", "is_analysis" : false }, { "field_name" : "engine_id", "is_analysis" : false }, { "field_name" : "request_length", "is_analysis" : false }, { "field_name" : "group_id", "is_analysis" : false }, { "field_name" : "requestid", "is_analysis" : false }, { "field_name" : "ssl_curves", "is_analysis" : false }, { "field_name" : "ssl_session_reused", "is_analysis" : false }, { "field_name" : "waf-time", "is_analysis" : false }, { "field_name" : "upstream_response_time", "is_analysis" : false }, { "field_name" : "time", "is_analysis" : false }, { "field_name" : "waf_category", "is_analysis" : false }, { "field_name" : "eng_ip", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "WAF_ACCESS", "template_id" : "", "quick_analysis" : false } 创建WAF攻击日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "policy_id", "is_analysis" : false }, { "field_name" : "hport", "is_analysis" : false }, { "field_name" : "body_bytes_sent", "is_analysis" : false }, { "field_name" : "hostid", "is_analysis" : false }, { "field_name" : "rule", "is_analysis" : false }, { "field_name" : "engine_ip", "is_analysis" : false }, { "field_name" : "pid", "is_analysis" : false }, { "field_name" : "http_host", "is_analysis" : false }, { "field_name" : "process_time", "is_analysis" : false }, { "field_name" : "reqid", "is_analysis" : false }, { "field_name" : "time_iso8601", "is_analysis" : false }, { "field_name" : "upstream_status", "is_analysis" : false }, { "field_name" : "hit_data", "is_analysis" : false }, { "field_name" : "attack_stream_id", "is_analysis" : false }, { "field_name" : "remote_ip", "is_analysis" : false }, { "field_name" : "attack", "is_analysis" : false }, { "field_name" : "tenantid", "is_analysis" : false }, { "field_name" : "host", "is_analysis" : false }, { "field_name" : "action", "is_analysis" : false }, { "field_name" : "backend.protocol", "is_analysis" : false }, { "field_name" : "backend.alive", "is_analysis" : false }, { "field_name" : "backend.port", "is_analysis" : false }, { "field_name" : "backend.host", "is_analysis" : false }, { "field_name" : "backend.weight", "is_analysis" : false }, { "field_name" : "backend.type", "is_analysis" : false }, { "field_name" : "id", "is_analysis" : false }, { "field_name" : "sip", "is_analysis" : false }, { "field_name" : "projectid", "is_analysis" : false }, { "field_name" : "web_tag", "is_analysis" : false }, { "field_name" : "attack-time", "is_analysis" : false }, { "field_name" : "method", "is_analysis" : false }, { "field_name" : "cookie", "is_analysis" : false }, { "field_name" : "level", "is_analysis" : false }, { "field_name" : "params", "is_analysis" : false }, { "field_name" : "x_real_ip", "is_analysis" : false }, { "field_name" : "url", "is_analysis" : false }, { "field_name" : "x_forwarded_for", "is_analysis" : false }, { "field_name" : "cdn_src_ip", "is_analysis" : false }, { "field_name" : "enterprise_project_id", "is_analysis" : false }, { "field_name" : "req_body", "is_analysis" : false }, { "field_name" : "engine_id", "is_analysis" : false }, { "field_name" : "group_id", "is_analysis" : false }, { "field_name" : "requestid", "is_analysis" : false }, { "field_name" : "multipart", "is_analysis" : false }, { "field_name" : "header", "is_analysis" : false }, { "field_name" : "location", "is_analysis" : false }, { "field_name" : "upstream_response_time", "is_analysis" : false }, { "field_name" : "time", "is_analysis" : false }, { "field_name" : "waf_category", "is_analysis" : false }, { "field_name" : "sport", "is_analysis" : false }, { "field_name" : "status", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "WAF_ATTACK", "template_id" : "", "quick_analysis" : false } 创建DMS重平衡日志的系统模板 { "log_group_id" : "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id" : "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields" : [ { "field_name" : "level", "is_analysis" : false }, { "field_name" : "timestamp", "is_analysis" : false }, { "field_name" : "message.leaderId", "is_analysis" : false }, { "field_name" : "message.generationId", "is_analysis" : false }, { "field_name" : "message.reason", "is_analysis" : false }, { "field_name" : "message.groupId", "is_analysis" : false }, { "field_name" : "message.coordinatorId", "is_analysis" : false }, { "field_name" : "message.type", "is_analysis" : false }, { "field_name" : "message.group", "is_analysis" : false } ], "tag_fields" : [ { "field_name" : "hostIP", "is_analysis" : true } ], "template_type" : "built_in", "template_name" : "DMS_REBALANCED", "template_id" : "", "quick_analysis" : false }
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述 枚举值: Invalid projectId 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_group_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:36 最大长度:36 log_stream_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:36 最大长度:36 template_id 是 String 所用模板id。当使用系统模板时,当前属性可以为空 最小长度:0 最大长度:36 template_name 是 String 所用模板名称,会对模板名称及id进行校验 最小长度:1 最大长度:64 template_type 是 String 所用模板类型,分为built_in及custom两种类型,对应系统模板和自定义模板,系统模板分为CTS,VPC、ELB、APIG、DCS审计日志、TOMCAT、NGINX、GAUSSDB_OPENGAUSS_AUDIT、DDS审计日志、DDS错误日志、DDS慢日志、CFW访问控制日志、CFW攻击日志、CFW流量日志、MYSQL错误日志、MYSQL慢日志、POSTGRESQL慢日志、POSTGRESQL错误日志、SQLSERVER错误日志、GAUSSDB_REDIS慢日志、GAUSSDB_MYSQL慢日志、GAUSSDB_MYSQL错误日志、CDN、SMN、WAF访问日志、WAF攻击日志、DMS重平衡日志。 枚举值: built_in custom demo_fields 否 Array of FieldModel objects 示例字段数组,填写与模板中is_analysis参数状态不同的字段。 tag_fields 否 Array of FieldModel objects Tag字段数组,填写与模板中is_analysis参数状态不同的字段。 quick_analysis 否 Boolean 是否开启demo_fields和tag_fields快速分析,为true时,所有的demo_fields和tag_fields全部字段均打开快速分析;不填或者为false,以模板中的demo_fields和tag_fields中的is_analysis决定是否开启快速分析。 表4 FieldModel 参数 是否必选 参数类型 描述 field_name 是 String 字段名称 最小长度:1 最大长度:64 is_analysis 否 Boolean 是否开启快速分析。
  • 响应示例 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.2014", "error_msg" : "desc is invalid!" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2014", "error_msg" : "Failed to create notification template." }
  • 请求示例 创建消息模板 POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates { "name" : "xxx", "desc" : "xxxxxx", "type" : [ ], "source" : "LTS", "locale" : "zh-cn", "templates" : [ { "sub_type" : "sms", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "dingding", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "wechat", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "webhook", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "email", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n告警源:$event.metadata.resource_provider;\n资源类型:$event.metadata.resource_type;\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;\n查询时间:$event.annotations.results[0].time;\n查询日志:$event.annotations.results[0].raw_results;" }, { "sub_type" : "voice", "content" : "告警级别:${event_severity}; \n发生时间:${starts_at}; \n资源标识:${resources}; \n统计类型:关键词统计; \n表达式:$event.annotations.condition_expression; \n当前值: $event.annotations.current_value; \n统计周期:$event.annotations.frequency;" } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 name String 通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改 最小长度:1 最大长度:100 type Array of strings 保留字段,非必填 desc String 模板描述,必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024 最小长度:0 最大长度:1024 source String 模板来源,目前必填为LTS,否则会筛选不出来 最小长度:3 最大长度:3 locale String 语言,必填,目前可填zh-cn和en-us 枚举值: zh-cn en-us templates Array of SubTemplateResBody objects 模板正文,为一个数组 表6 SubTemplateResBody 参数 参数类型 描述 sub_type String 模板子类型,只支持以下6种类型:sms,dingding,wechat,webhook,email 枚举值: 枚举值: sms dingding wechat webhook email voice content String 子模版正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。目前两种告警类型有共同变量如下: 告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 关键词告警特有变量: 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results; sql告警特有变量: 日志组/流名称:$event.annotations.results[0].resource_id; 查询语句:$event.annotations.results[0].sql; 查询时间:$event.annotations.results[0].time; 查询URL:$event.annotations.results[0].url; 查询日志:$event.annotations.results[0].raw_results; 说明: 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • URI POST /v2/{project_id}/{domain_id}/lts/events/notification/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 domain_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改 最小长度:1 最大长度:100 type 否 Array of strings 保留字段,非必填 desc 是 String 模板描述,必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024 最小长度:0 最大长度:1024 source 是 String 模板来源,目前必填为LTS,否则会筛选不出来 最小长度:3 最大长度:3 locale 是 String 语言,必填,目前可填zh-cn和en-us 枚举值: zh-cn en-us templates 是 Array of SubTemplate objects 模板正文,为一个数组 表4 SubTemplate 参数 是否必选 参数类型 描述 sub_type 是 String 模板子类型,只支持以下5种类型:sms,dingding,wechat,webhook,email 枚举值: sms dingding wechat webhook email voice content 是 String 子模版正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。目前两种告警类型有共同变量如下: 告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 关键词告警特有变量: 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results; sql告警特有变量: 日志组/流名称:$event.annotations.results[0].resource_id; 查询语句:$event.annotations.results[0].sql; 查询时间:$event.annotations.results[0].time; 查询URL:$event.annotations.results[0].url;查询日志:$event.annotations.results[0].raw_results; 说明: 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况 最小长度:2 最大长度:1024
  • 响应示例 状态码: 200 删除日志接入请求响应成功 { "result" : [ { "access_config_detail" : { "black_paths" : [ "/wjy/hei/tesxxx", "/wjy/hei/tesxxx" ], "format" : { "single" : { "mode" : "wildcard", "value" : "1111" } }, "paths" : [ "/wjy/tesxxx", "/wjy/texxx", "/wjyxxxxx" ], "windows_log_info" : { "categorys" : [ "System", "Application", "Security", "Setup" ], "event_level" : [ "information", "warning", "error", "critical", "verbose" ], "time_offset" : { "offset" : 168, "unit" : "hour" } } }, "access_config_id" : "aa58d29e-21a9-4761-ba16-8xxxxx", "access_config_name" : "采集Wjyxxxxxt2", "access_config_tag" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx1", "value" : "xxx1" } ], "access_config_type" : "AGENT", "create_time" : 1635043645628, "host_group_info" : { "host_group_id_list" : [ "de4dbed4-a3bc-4877-a7ee-0xxxxxx6" ] }, "log_info" : { "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e89xxxxx0", "log_group_name" : "lts-groupxxxxxka", "log_stream_id" : "c4de0538-53e6-41fd-b951-a8xxxxx58d7", "log_stream_name" : "lts-topic-txxxxx" } } ], "total" : 1 } 状态码: 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid access config id" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 access_config_id_list 是 Array of strings 日志接入ID列表 最小长度:36 最大长度:36
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 sql_alarm_rules Array of SqlAlarmRuleRespList objects SQL告警 表4 SqlAlarmRuleRespList 参数 参数类型 描述 sql_alarm_rule_name String SQL告警名称 最小长度:1 最大长度:64 is_css_sql Boolean 是否管道符sql查询 缺省值:false sql_alarm_rule_id String SQL告警规则id 最小长度:36 最大长度:36 sql_alarm_rule_description String SQL告警信息描述 最小长度:0 最大长度:64 sql_requests Array of SqlRequest objects SQL详细信息 frequency FrequencyRespBody object 告警统计周期 condition_expression String 条件表达式 最小长度:1 最大长度:1024 topics Array of Topics objects 主题信息 sql_alarm_level String 告警级别 枚举值: Info Minor Major Critical sql_alarm_send Boolean 是否发送 domain_id String domainId 最小长度:32 最大长度:32 create_time Long 创建时间(毫秒时间戳) 最小值:13 最大值:13 update_time Long 更新时间(毫秒时间戳) 最小值:13 最大值:13 template_name String 消息模板名称 status String 告警状态 枚举值: RUNNING 启用 STOPPING 停止 trigger_condition_count Integer 触发条件:触发周期;默认为1 trigger_condition_frequency Integer 触发条件:触发周期;默认为1 whether_recovery_policy Boolean 是否打开恢复通知;默认false recovery_policy Integer 恢复策略周期;默认为3 notification_frequency Integer 通知频率,单位(分钟) 枚举值: 0 5 10 15 30 60 180 360 alarm_action_rule_name String 告警行动规则名称 说明: alarm_action_rule_name和notification_save_rule可以选填一个,如果都填,优先选择alarm_action_rule_name 表5 SqlRequest 参数 参数类型 描述 is_time_range_relative Boolean 是时间范围相对 log_stream_id String 日志流id 最小长度:36 最大长度:36 log_stream_name String 日志流名称 最小长度:1 最大长度:64 log_group_id String 日志组id 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 sql String sql语句 最小长度:1 最大长度:1024 sql_request_title String 图表名称 最小长度:1 最大长度:64 search_time_range Integer 查询执行任务时最近数据的时间范围(当search_time_range_unit为minute,则最大值为60;当search_time_range_unit为hour,则最大值为24) 最小值:1 最大值:60 search_time_range_unit String 查询时间单位 枚举值: minute hour 表6 FrequencyRespBody 参数 参数类型 描述 type String 时间类型。 枚举值: CRON HOURLY DAILY WEEKLY FIXED_RATE cron_expr String 当字段type为"CRON"时取该字段。 最小长度:1 最大长度:1024 hour_of_day Integer 当字段type为"DAILY"或者"WEEKLY"时取该字段。 day_of_week Integer 当字段type为"WEEKLY"时取该字段(周日~周六)。 fixed_rate Integer 当字段type为"FIXED_RATE"时取该字段(当fixed_rate_unit单位为minute,最大值60;当fixed_rate_unit单位为hour,最大值24)。 fixed_rate_unit String 时间单位枚举值: 枚举值: minute hour 表7 Topics 参数 参数类型 描述 name String 主题名称。 最小长度:1 最大长度:1024 topic_urn String Topic的唯一的资源标识。 最小长度:1 最大长度:1024 display_name String Topic的显示名,推送邮件消息时,作为邮件发件人显示。 最小长度:1 最大长度:1024 push_policy Integer 消息推送的策略。 最小值:1 最大值:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 响应示例 状态码: 200 请求响应成功。 { "sql_alarm_rules" : [ { "sql_alarm_rule_name" : "string", "is_css_sql" : false, "sql_alarm_rule_id" : "string", "sql_alarm_rule_description" : "string", "sql_requests" : [ { "log_stream_id" : "string", "log_stream_name" : "string", "log_group_id" : "string", "log_group_name" : "string", "sql" : "string", "sql_request_title" : "string", "search_time_range" : 0, "search_time_range_unit" : "minute" } ], "frequency" : { "type" : "CRON", "cron_expr" : "string", "hour_of_day" : 0, "day_of_week" : 0, "fixed_rate" : 0, "fixed_rate_unit" : "minute" }, "condition_expression" : "string", "topics" : [ { "name" : "string", "topic_urn" : "string", "display_name" : "string", "push_policy" : 0 } ], "sql_alarm_level" : "Info", "sql_alarm_send" : true, "domain_id" : "string", "create_time" : 0, "update_time" : 0, "template_name" : "消息模板名称", "status" : "RUNNING", "trigger_condition_count" : "1", "trigger_condition_frequency" : "1", "whether_recovery_policy" : false, "recovery_policy" : "3", "notification_frequency" : 5, "alarm_action_rule_name" : "" } ] } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2008", "error_msg" : "Find Alarm rule failed." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 响应示例 状态码: 200 删除转储请求响应成功。 { "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0", "log_group_name" : "lts-group-kafka", "log_streams" : [ { "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8", "log_stream_name" : "lts-topic-kafka" } ], "log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc", "log_transfer_info" : { "log_create_time" : 1634802241847, "log_storage_format" : "JSON", "log_agency_transfer" : { "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", "agency_domain_name" : "paas_apm_z004xxxxx_xx", "agency_name" : "test20210325", "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx", "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx" }, "log_transfer_detail" : { "obs_period" : 2, "obs_prefix_name" : "", "obs_period_unit" : "min", "obs_transfer_path" : "/0002/LogTanks/xxx/", "obs_bucket_name" : "0002", "obs_encrypted_enable" : false, "obs_dir_pre_fix_name" : "", "obs_time_zone" : "UTC+01:00", "obs_time_zone_id" : "Africa/Lagos", "dis_id" : "xxxxx", "dis_name" : "xxxxxx", "kafka_id" : "xxxxxx", "kafka_topic" : "xxxxx" }, "log_transfer_mode" : "cycle", "log_transfer_status" : "ENABLE", "log_transfer_type" : "OBS" } } 状态码: 400 BadRequest 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.0405", "error_msg" : "The log transfer does not existed" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 log_group_id String 日志组ID 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 log_streams Array of log_streams objects 日志流集合 log_transfer_id String 日志转储ID 最小长度:36 最大长度:36 log_transfer_info log_transfer_info_RespBody object 日志转储信息 表5 log_streams 参数 参数类型 描述 log_stream_id String 日志流ID 最小长度:36 最大长度:36 log_stream_name String 日志流名称 最小长度:1 最大长度:64 表6 log_transfer_info_RespBody 参数 参数类型 描述 log_agency_transfer log_agency_transfer object 委托转储信息。若转储为委托转储,则会返回该参数 log_create_time Integer 日志转储创建时间 最小值:0 最大值:2147483647 log_storage_format String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式,JSON是指JSON日志格式。OBS转储和DIS转储支持JSON和RAW,DMS转储仅支持RAW 枚举值: JSON RAW log_transfer_detail TransferDetail object 日志转储详细信息 log_transfer_mode String 日志转储方式。cycle是指周期性转储,realTime是指实时转储。OBS转储只支持"cycle",DIS转储和DMS转储只支持"realTime"。 枚举值: cycle realTime log_transfer_status String 日志转储状态,ENABLE是指日志转储开启状态,DISABLE是指日志转储关闭状态,EXCEPTION是指日志转储异常状态 枚举值: ENABLE DISABLE EXCEPTION log_transfer_type String 日志转储类型。OBS指OBS日志转储,DIS指DIS日志转储,DMS指DMS日志转储。 枚举值: OBS DIS DMS 表7 log_agency_transfer 参数 参数类型 描述 agency_domain_id String 委托方账号ID 最小长度:1 最大长度:128 agency_domain_name String 委托方账号名称 最小长度:1 最大长度:128 agency_name String 委托方配置的委托名称 最小长度:1 最大长度:128 agency_project_id String 委托方项目ID 最小长度:32 最大长度:32 be_agency_domain_id String 被委托方账号ID,实际配置转储的账号ID 最小长度:1 最大长度:128 be_agency_project_id String 被委托方项目ID,实际配置转储的账号的项目ID 最小长度:32 最大长度:32 表8 TransferDetail 参数 参数类型 描述 obs_period Integer OBS转储时间。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: 1 2 3 5 6 12 30 obs_period_unit String OBS转储单位。当创建OBS转储时,必填此参数。与obs_period_unit组合,即"obs_period"+"obs_period_unit",必须是"2min", "5min", "30min", "1hour", "3hour", "6hour","12hour"。 枚举值: “min” “hour” obs_bucket_name String OBS日志桶名称。当创建OBS转储时,必填此参数。 最小长度:3 最大长度:63 最小长度:3 最大长度:63 obs_encrypted_id String OBS转储KMS秘钥ID。根据OBS转储日志桶是否加密判断,若OBS转储日志桶加密则必须填写该参数,若OBS转储日志桶则不需要此参数。 最小长度:36 最大长度:36 最小长度:36 最大长度:36 obs_dir_pre_fix_name String OBS转储自定义转储路径。当创建OBS转储时,根据需要选填此参数。 正则约束: ^(/)?([a-zA-Z0-9.-]+)(/[a-zA-Z0-9.-]+)*(/)?$ 最小长度:1 最大长度:64 最小长度:1 最大长度:64 obs_prefix_name String OBS转储日志文件前缀。当创建OBS转储时,根据需要选填此参数。 正则约束: ^[a-zA-Z0-9._-]*$ 最小长度:1 最大长度:64 最小长度:1 最大长度:64 obs_time_zone String OBS转储时区(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。如果选择该参数,则必须选择obs_time_zone_id。 obs_time_zone_id String OBS转储时区ID(https://support.huaweicloud.com/api-lts/lts_api_0111.html)。参数选择参考OBS转储时区表。如果选择该参数,则必须选择obs_time_zone。 dis_id String DIS转储通道ID。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 最小长度:1 最大长度:128 dis_name String DIS转储通道名称。当创建DIS转储时,必填此参数。 最小长度:1 最大长度:128 最小长度:1 最大长度:128 kafka_id String DMS转储kafka ID。当创建DMS转储时,必填此参数。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度:36 最大长度:36 kafka_topic String DMS转储kafka topic。 创建DMS转储前,需要使用kafka ID以及kafka Topic进行实例注册。详情见接口注册DMSkafka实例 最小长度:1 最大长度:128 obs_transfer_path String OBS转储路径,指OBS日志桶中的路径。 最小长度:0 最大长度:256 obs_eps_id String OBS企业项目ID。 最小长度:0 最大长度:128 obs_encrypted_enable Boolean OBS是否开启加密。 枚举值: true false tags Array of strings 若开启tag投递,该字段必须包含主机信息:hostIP、hostId、hostName、pathFile、collectTime; 公共字段有:logStreamName、regionName、logGroupName、projectId,为可选填; 开启转储标签:streamTag,可选填 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • URI DELETE /v2/{project_id}/transfers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 log_transfer_id 是 String 日志转储ID。获取ID有3种方式: 1. 调用查询日志转储接口,返回值有日志转储ID 2. 调用新增日志转储接口,返回值有日志转储ID 最小长度:36 最大长度:36
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 result String 响应结果 状态码: 400 表5 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表6 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 details String 错误描述 最小长度:2 最大长度:512 状态码: 500 表7 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表8 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 details String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 201 创建仪表盘分组成功 { "result" : "success" } 状态码: 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.2111", "details" : "Log dashboard group name is already exist" } } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }
共100000条