华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从 IAM 服务获取的用户Token，获取方式请参见：获取用户Token。 最小长度：1 最大长度：10000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 access_config_id_list 是 Array of strings 日志接入ID列表 最小长度：36 最大长度：36

响应示例 状态码： 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" : "Internal Server Error"}

响应示例 状态码为 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转储时，会返回如下参数 "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转储时，会返回如下参数 "dis_id":"xxxxx", "dis_name":"xxxxxx" //当创建DMS转储时，会返回如下参数 "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 表6 object 日志转储信息 表5 log_streams 参数 参数类型 描述 log_stream_id String 日志流ID 最小长度：36 最大长度：36 log_stream_name String 日志流名称 最小长度：1 最大长度：64 表6 log_transfer_info 参数 参数类型 描述 log_agency_transfer 表7 object 委托转储信息。若转储为委托转储，则会返回该参数 log_create_time Integer 日志转储创建时间 最小值：0 最大值：9999999999999 log_storage_format String 日志转储格式。只支持"RAW", "JSON"。RAW是指原始日志格式，JSON是指JSON日志格式。 枚举值： JSON RAW log_transfer_detail 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日志转储 枚举值： 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 状态码为400 时: 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码为 500 时: 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述。

URI DELETE /v2/{project_id}/transfers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见：获取帐号ID、项目ID、日志组ID、日志流ID。 最小长度：32 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 log_transfer_id 是 String 日志转储ID。获取ID有2种方式： 1. 调用查询日志转储接口，返回值有日志转储ID 2. 调用新增日志转储接口，返回值有日志转储ID 最小长度：36 最大长度：36

响应示例 状态码： 200 创建日志接入请求响应成功 { "access_config_detail" : { "black_paths" : ["/wjy/hei/tesxxx", "/wjy/hei/tesxxx"], "format" : { "single" : { "mode" : "wildcard", "value" : "1111" } }, "paths" : ["/wjy/tesxxx"], "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-8cxxxxd", "access_config_name" : "采集Wjy_xxxxt2", "access_config_tag": [ { "key": "xxx", "value": "xxx" }, { "key": "xxx1", "value": "xxx1" } ], "access_config_type" : "AGENT", "create_time" : 163504314523, "host_group_info" : { "host_group_id_list" : ["de4dbed4-a3bc-4877-a7ee-09xxxxxx"] }, "log_info" : { "log_group_id" : "9a7e2183-2d6d-4732-9axxxxx49e0", "log_group_name" : "lts-groupxxxa", "log_stream_id" : "c4de0538-53e6-41fd-b951-xxxx8d7", "log_stream_name" : "lts-topixxx" } } 状态码： 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid access config name" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }

请求示例 创建日志接入 POST https://{endpoint}/v3/{project_id}/lts/access-config /v3/{project_id}/lts/access-config { "access_config_name" : "Tesxxx", "access_config_type" : "AGENT", "access_config_detail" : { "paths" : ["/test/xxx", "/texxx"], "black_paths" : ["/testxxx", "/tesxxx"], "format" : { "multi" : { "mode" : "time", "value" : "YYYY-MM-DD hh:mm:ss" } }, "windows_log_info" : { "categorys" : ["System", "Security", "Setup"], "event_level" : ["warning", "error", "critical", "verbose"], "time_offset" : { "offset" : 111, "unit" : "hour" } } }, "log_info" : { "log_group_id" : "b179326d-c3be-4217-a3d9-xxxx", "log_stream_id" : "020a6fa0-4740-4888-af06-98xxxxxx" }, "host_group_info" : { "host_group_id_list" : ["4ee44d4f-a72b-40cf-a3c7-1xxxxx"] }, "access_config_tag": [ { "key": "xxx", "value": "xxx" }, { "key": "xxx1", "value": "xxx1" } ]}

请求示例 修改日志接入 PUT https://{endpoint}/v3/{project_id}/lts/access-config /v3/{project_id}/lts/access-config { "access_config_id" : "ed90802a-8475-4702-955e-e3ee16a5dde9", "access_config_detail" : { "paths" : ["/test/222", "/test/111"], "black_paths" : [], "format" : { "multi" : { "mode" : "regular", "value" : "aaaa" } }, "windows_log_info" : { "categorys" : ["Application", "System"], "time_offset" : { "offset" : 7, "unit" : "day" }, "event_level" : ["information", "warning", "error", "critical", "verbose"] } }, "host_group_info" : { "host_group_id_list" : ["de4dbed4-a3bc-4877-a7ee-096a2a63e036"] }, "access_config_tag": [ { "key": "xxx", "value": "xxx" }, { "key": "xxx1", "value": "xxx1" } ] }

响应示例 状态码： 200 修改日志接入请求响应成功 { "access_config_detail" : { "black_paths" : ["/wjy/hei/tesxxx", "/wjy/hei/tesxxx"], "format" : { "single" : { "mode" : "wildcard", "value" : "1111" } }, "paths" : ["/wjy/tesxxx"], "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-8cxxxxd", "access_config_name" : "采集Wjy_xxxxt2", "access_config_tag": [ { "key": "xxx", "value": "xxx" }, { "key": "xxx1", "value": "xxx1" } ], "access_config_type" : "AGENT", "create_time" : 163504332654, "host_group_info" : { "host_group_id_list" : ["de4dbed4-a3bc-4877-a7ee-09xxxxxx"] }, "log_info" : { "log_group_id" : "9a7e2183-2d6d-4732-9axxxxx49e0", "log_group_name" : "lts-groupxxxa", "log_stream_id" : "c4de0538-53e6-41fd-b951-xxxx8d7", "log_stream_name" : "lts-topixxx" }} 状态码： 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid access config id" } 状态码： 500 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }

响应示例 状态码： 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." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 log_group_id 是 String 日志组ID，获取方式请参见：获取账号ID、项目ID、日志组ID、日志流ID 最小长度：36 最大长度：36 log_stream_id 是 String 日志流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、D CS 审计日志、TOMCAT、NGINX、GAUSSDB_OPENGAUSS_AUDIT、DDS审计日志、DDS错误日志、DDS慢日志、CFW访问控制日志、CFW攻击日志、CFW流量日志、MYSQL错误日志、MYSQL慢日志、POSTGRESQL慢日志、POSTGRESQL错误日志、SQLSERVER错误日志、GAUSSDB_REDIS慢日志、GAUSSDB_MYSQL慢日志、GAUSSDB_MYSQL错误日志、CDN、 SMN 。 枚举值： built_in custom demo_fields 否 Array of FieldModelobjects 示例字段数组，填写与模板中is_analysis参数状态不同的字段。 tag_fields 否 Array of FieldModelobjects 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 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述 枚举值： Invalid projectId 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述 枚举值： Invalid projectId

请求示例 系统模板：CTS { "log_group_id": "17f23e52-a23d-46e0-8bc5-xxxxxxxxxxxx", "log_stream_id": "b4d56d47-b4c4-453e-9047-xxxxxxxxxxxx", "demo_fields": [ { "field_name": "code" }, { "field_name": "event_type" }, { "field_name": "project_id" }, { "field_name": "record_time" }, { "field_name": "resource_id" }, { "field_name": "resource_name" }, { "field_name": "resource_type" }, { "field_name": "service_type" }, { "field_name": "source_ip" }, { "field_name": "time" }, { "field_name": "trace_id" }, { "field_name": "trace_name" }, { "field_name": "trace_rating" }, { "field_name": "trace_type" }, { "field_name": "tracker_name" }, { "field_name": "user.domain.id" }, { "field_name": "user.domain.name" }, { "field_name": "user.id" }, { "field_name": "user.name" } ], "tag_fields": [ { "field_name": "hostIP" } ], "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 } ], "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 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 results Array of BriefStructTemplateModel objects 结构化模板缩略信息列表 表4 BriefStructTemplateModel 参数 参数类型 描述 create_time Integer 模板创建/更新时间 最小值：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 请求响应成功。 { "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." }

响应参数 状态码为 201 时: 表5 响应Body参数 参数 参数类型 描述 instance_id String kafka ID 状态码为 400 时: 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述。 枚举值： Invalid projectId 状态码为 500 时: 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：8 error_msg String 调用失败响应信息描述。

请求示例 注册DMS kafka实例 POST https://{endpoint}/v2/{project_id}/lts/dms/kafka-instance /v2/{project_id}/lts/dms/kafka-instance { "instance_id" : "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6", "kafka_name" : "kafka-wxxxxxt", "connect_info" : { "user_name" : "111", "pwd" : "2222" }}

响应示例 状态码为 201 时: 注册DmsKafka请求响应成功。 { "instance_id" : "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6" } 状态码为 400 时: BadRequest 非法请求建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1719", "error_msg" : "kafka user or password wrong" } 状态码为 500 时: 表明服务端能被请求访问到，但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token，获取方式请参见：获取用户Token 最小长度：1000 最大长度：2000 Content-Type 是 String 该字段填为：application/json;charset=UTF-8。 最小长度：30 最大长度：30 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_id 是 String kafka ID 最小长度：1 最大长度：36 kafka_name 是 String kafka 名称 最小长度：1 最大长度：256 connect_info 是 connect_info object kafka连接信息。购买kafka时，SASL_SSL是否配置，如果有，则需要填写账号密码 表4 connect_info 参数 是否必选 参数类型 描述 user_name 否 String 账号 最小长度：1 最大长度：256 pwd 否 String 密码 最小长度：1 最大长度：256

消息接收 表1 QueryMessageEvent参数说明 参数名 数据类型 选取原则 说明 eventId number 必选 事件ID为168001。 callId object 必选 呼叫标识。 dataMode string 可选 0-push：数据直接推送，ACS数据长度需小于3K。 1-pull：数据不直接推送，接收方需通过获取URL得到数据。 说明： 暂不支持dataMode=1的场景。 message string 必选 消息内容。 父主题： 事件通知

数据通道状态通知 该事件通知接入侧数据通道是否能接收数据。 表1 CallMessageStatusEvent参数 参数名 数据类型 选取原则 说明 eventId number 必选 事件ID为168002。 callId object 必选 呼叫标识。 allowMessage string 必选 0：数据通道禁止传输数据。 1：数据通道允许传输数据；表示目的设备与用户已经接通。 vdnId string 必选 设备所在的VDN信息。 deviceType string 必选 设备类型。 1：队列 2：agent 3：IVR deviceNo string 必选 设备号。 ctiId string 可选 CTI平台ID，在订阅通知模式下携带 父主题： 事件通知

呼叫排队 该事件通知接入侧呼叫正在排队。 表1 CallStateCallQueued参数 参数名 数据类型 说明 eventId number 事件ID为： 168102 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件

呼叫建立成功 该事件通知接入侧为该呼叫建立。 表1 CallStateConnected参数 参数名 数据类型 说明 eventId number 事件ID为168101。 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 deviceType string 当前设备类型。 1：队列 2：agent（坐席） 3：IVR deviceNo string 当前设备号。 accessCode string 在点击通话呼叫中返回特殊路由接入码与uvid的组合。 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记（用于协助呼叫）。 父主题： VOIP音视频呼叫事件

呼叫释放事件 该事件通知接入侧为该呼叫已经被释放。 表1 CallStateDisConnected参数 参数名 数据类型 说明 eventId number 事件ID: 168110 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 deviceType string 当前设备类型。 1：队列 2：agent（坐席） 3：IVR deviceNo string 当前设备号。 causeId number 呼叫释放的CTI平台原因码： -1：一般原因 causeDesc string 呼叫释放的CTI平台原因描述 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件

呼叫排队超时 该事件通知接入侧呼叫排队超时。 表1 CallQueueTimeout参数 参数名 数据类型 说明 eventId number 事件ID为： 168103 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 causeId number 呼叫释放的CTI平台原因码： 22002：排队超时时路由失败。 causeDesc string 呼叫释放的CTI平台原因描述 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件

错误码参考 CCUCS分配的错误码范围是1-164000。 错误码 描述 1 CCUCS不需要恢复该会话。 160000 请求参数异常。 160001 平台通信异常。 160002 WebM通信异常。 160003 无可用的WebM。 160004 CCUCS没有找到会话。 160005 CCUCS没有会话需要释放。 160006 数据库操作失败。 160007 呼叫不存在。 160008 与公共包的监控线程握手失败。 160009 请求非法。 160010 sendMessage消息，dataMode参数错误，只允许0和1。 160011 sendMessage消息，dataMessage写文件服务器失败。 160012 sendMessage消息，dataMode为0时，dataMessage需小于3k。 160013 呼叫排队中。 160014 CCS通讯异常。 160015 呼叫已经被释放。 160016 secMode参数错误，只允许0和1。 160017 消息队列已满。 160018 在线呼叫数超过最大限制。 160019 呼叫事件无法推送。 160020 当前会话不能创建呼叫。 160021 呼叫已经转到座席。 160022 呼叫在IVR流程中。 160023 呼叫在私有队列中。 160024 坐席未应答。 160025 容灾恢复重复创建session。 160026 容灾恢复查询呼叫信息，数据库查询异常。 160027 平台加密模式下原始消息长度需小于1.9k。 160028 Token异常。 160029 鉴权开关关闭。 160030 鉴权异常（无鉴权配置文件）。 160031 登录/更新场景：鉴权异常。 160032 用户锁定。 160033 客户端IP没有权限访问。 1640034 数据库操作异常。 160035 当前数据源加载模式下不支持该操作。 164000 未知错误，请联系管理员。 CCUCS分配的事件原因码范围是164001-164999。 事件原因码 描述 164001 CCUCS与WebM断连。 164002 WebM已不存在呼叫。 164003 呼叫超时释放。 164004 session超时释放。 WebM返回的错误码 事件原因码 描述 20139 没有座席签入,即QueueType和AgentType都不可用 21053 非本CCS管理的VDN 20348 座席无处理此种呼叫的能力 20388 路由到坐席失败

呼叫转移时保持呼叫 该事件通知接入侧当前呼叫在呼叫转移时被保持呼叫。 表1 TransferHold参数 参数名 数据类型 说明 eventId number 事件ID为： 168111 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件

呼叫失败 该事件通知接入侧用户呼叫失败。 表1 CallFail参数 参数名 数据类型 说明 eventId number 事件ID为： 168105 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 causeId number 呼叫释放的CTI平台原因码。 causeDesc string 呼叫释放的CTI平台原因描述 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件

用户取消排队 暂不支持VoIP取消排队操作。 该事件通知接入侧用户取消排队。 表1 CallCancelQueue参数 参数名 数据类型 说明 eventId number 事件ID为： 168104 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 causeId number 呼叫释放的CTI平台原因码： 22001：取消排队 causeDesc string 呼叫释放的CTI平台原因描述 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件

呼叫转移 该事件通知接入侧呼叫被当前坐席转移给其他坐席处理。 表1 CallTransfer参数 参数名 数据类型 说明 eventId number 事件ID为： 168106 callId object 呼叫标识。 vdnId string 设备所在的VDN信息。 content object 事件内容对象。该对象的详细说明请参加表2。 表2 content对象参数说明 参数名 数据类型 说明 mediaType string 媒体类型： 1：多媒体渠道呼叫 2：语音视频呼叫 origedDeviceType string 原始设备类型。 1：队列 2：agent（坐席） 3：IVR origedDeviceNo string 原始设备号。 deviceType string 当前设备类型。 1：队列 2：agent（坐席） 3：IVR deviceNo string 当前设备号。 uvid string 同一个用户的呼叫标记(用于协助呼叫)。 父主题： VOIP音视频呼叫事件