华为云用户手册

  • 请求示例 查询主机组信息,根据传入的Body体进行过滤。若是body体中无过滤参数,则查询全量数据。 POST https://{endpoint}/v3/{project_id}/lts/host-group-list { "host_group_id_list" : [ "bca6d903-3528-42a8-91f4-586722cxxxxx" ], "filter" : { "host_group_type" : "lixxx", "host_group_name_list" : [ "wjyTxxx", "xxxest" ], "host_name_list" : [ "ecs-apmtexxx删" ], "host_group_tag" : { "tag_type" : "AND", "tag_list" : [ { "key" : "xxx", "value" : "xxx" } ] } } }
  • 响应示例 状态码: 200 查询主机组列表请求响应成功 { "result" : [ { "host_group_id" : "598c77aa-c69b-42f0-8cb8-xxxx5b38", "host_group_name" : "devspoxxxou1", "host_group_type" : "lxxux", "host_id_list" : [ "dc1dab7e-b04xxxx", "xxxxx" ], "host_group_tag" : [ { "key" : "xxx", "value" : "xxx" }, { "key" : "xxx", "value" : "xxx" } ], "create_time" : 1635459410332, "update_time" : 163560332 } ], "total" : 1 } 状态码: 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid host group id" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "Internal Server Error" }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 result Array of GetHostGroupInfo objects 主机组列表 total Long 主机组信息总数量 最小值:0 最大值:1000 表8 GetHostGroupInfo 参数 参数类型 描述 host_group_id String 主机组ID 最小长度:36 最大长度:36 host_group_name String 主机组名称 最小长度:1 最大长度:64 host_group_type String 主机组类型。linux:linux类型,windows:windows类型 枚举值: linux windows host_id_list Array of strings 主机ID列表 最小长度:36 最大长度:36 host_group_tag Array of HostGroupTagResBody objects 标签信息. create_time Long 创建时间 最小值:0 最大值:9999999999999 update_time Long 更新时间 最小值:0 最大值:9999999999999 表9 HostGroupTagResBody 参数 参数类型 描述 key String 标签Key 最小长度:1 最大长度:36 value String 标签Value 最小长度:1 最大长度:36 状态码: 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:8 error_msg String 错误描述 最小长度:1 最大长度:1000
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1 最大长度:10000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 表3 请求Body参数 参数 是否必选 参数类型 描述 host_group_id_list 否 Array of strings 主机组ID 最小长度:36 最大长度:36 filter 是 GetHostGroupListFilter object 主机组过滤参数 表4 GetHostGroupListFilter 参数 是否必选 参数类型 描述 host_group_type 否 String 主机组类型。windows:windows类型,linux:linux类型 枚举值: windows linux host_group_name_list 否 Array of strings 主机组名称列表。 最小长度:1 最大长度:64 host_name_list 否 Array of strings 主机名称列表。 最小长度:1 最大长度:128 host_group_tag 否 GetHostGroupListTag object 主机组标签信息 表5 GetHostGroupListTag 参数 是否必选 参数类型 描述 tag_type 否 String 标签类型。AND:标签过滤的逻辑为与,OR:标签过滤的逻辑为或 枚举值: AND OR tag_list 否 Array of HostGroupTag objects 主机组标签 表6 HostGroupTag 参数 是否必选 参数类型 描述 key 否 String 标签Key 最小长度:1 最大长度:128 value 否 String 标签Value 最小长度:0 最大长度:255
  • 请求示例 修改日志接入(ECS) PUT https://{endpoint}/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" : "The system encountered an internal error" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of CreateAomMappingRuleResp objects 请求响应成功, 成功获取单个接入配置。 表4 CreateAomMappingRuleResp 参数 参数类型 描述 project_id String 项目id rule_name String 接入规则名称 rule_id String 接入规则id rule_info AomMappingRuleInfoRespBody object 接入规则详情 表5 AomMappingRuleInfoRespBody 参数 参数类型 描述 cluster_id String 集群id cluster_name String 集群名称 deployments_prefix String 日志流前缀 deployments Array of strings 工作负载 namespace String 命名空间 container_name String 容器名称 files Array of AomMappingfilesInfos objects 接入规则详情 表6 AomMappingfilesInfos 参数 参数类型 描述 file_name String 路径名 log_stream_info AomMappingLogStreamInfos object 接入规则详情。 表7 AomMappingLogStreamInfos 参数 参数类型 描述 target_log_group_id String 日志组id target_log_group_name String 目标日志组名称 target_log_stream_id String 日志流id target_log_stream_name String 目标日志流名称 状态码: 400 表8 响应Body参数 参数 参数类型 描述 code String 错误码。 枚举值: LTS.0014 details String 调用失败响应信息描述。 枚举值: Operation DB failed 状态码: 401 表9 响应Body参数 参数 参数类型 描述 massage Massage401 object 接口调用信息。 表10 Massage401 参数 参数类型 描述 code String 错误码。 枚举值: LTS.0001 details String 调用失败响应信息描述。 枚举值: project verify error 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • 响应示例 状态码: 200 请求响应成功, 成功获取单个接入配置。 { "project_id" : "", "rule_id" : "", "rule_info" : { "cluster_id" : "", "cluster_name" : "", "container_name" : "", "deployments" : [ "" ], "files" : [ { "file_name" : "", "log_stream_info" : { "target_log_group_id" : "", "target_log_group_name" : "", "target_log_stream_id" : "", "target_log_stream_name" : "" } } ], "namespace" : "" }, "rule_name" : "" } 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "errorCode" : "LTS.0014", "errorMessage" : "Operation DB failed" } 状态码: 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0003", "error_msg" : "parse_token_failed" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0102", "error_msg" : "ServiceUnavailable." }
  • 状态码 状态码 描述 200 请求响应成功, 成功获取单个接入配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效, 服务不可用。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • URI GET /v2/{project_id}/lts/aom-mapping/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 rule_id 是 String 接入规则ID。 缺省值:None 最小长度:36 最大长度:36
  • 响应示例 状态码: 201 请求响应成功, 成功创建接入配置。 [ { "project_id" : "", "rule_id" : "", "rule_info" : { "cluster_id" : "", "cluster_name" : "", "container_name" : "", "deployments_prefix" : "deployments_prefix", "deployments" : [ "" ], "files" : [ { "file_name" : "", "log_stream_info" : { "target_log_group_id" : "", "target_log_group_name" : "", "target_log_stream_id" : "", "target_log_stream_name" : "" } } ], "namespace" : "" }, "rule_name" : "" } ] 状态码: 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 { "errorCode" : "LTS.0014", "errorMessage" : "Operation DB failed" } 状态码: 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 { "error_code" : "LTS.0414", "error_msg" : "Invalid token" } 状态码: 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 { "error_code" : "LTS.0003", "error_msg" : "parse_token_failed" } 状态码: 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0102", "error_msg" : "ServiceUnavailable." }
  • 请求示例 创建接入规则 POST https://{endpoint}/v2/{project_id}/lts/aom-mapping { "rule_name" : "abcde", "project_id" : "2a473356cca5487f8373be891bffc1cf", "rule_info" : { "cluster_id" : "4fae3587-0202-11eb-9ba9-0255ac100b02", "cluster_name" : "testdiskrate", "deployments_prefix" : "deployments_prefix", "deployments" : [ "__ALL_DEPLOYMENTS__" ], "namespace" : "default", "container_name" : "container-0", "files" : [ { "file_name" : "__ALL_FILES__", "log_stream_info" : { "target_log_group_id" : "8c9dcda6-d048-43a7-989b-c76c34b0ac85", "target_log_group_name" : "lts-group-wb28", "target_log_stream_id" : "2c228bd1-cbf1-41fb-b563-0ca2769202b2", "target_log_stream_name" : "mysql" } } ] } }
  • 状态码 状态码 描述 201 请求响应成功, 成功创建接入配置。 400 BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 401 AuthFailed。鉴权失败, 请确认token后再次请求 。 403 Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 500 InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 503 ServiceUnavailable。 被请求的服务无效,服务不可用。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 表4 请求Body参数 参数 是否必选 参数类型 描述 rule_name 是 String 接入规则名称 缺省值:None 最小长度:1 最大长度:100 rule_info 是 AomMappingRuleInfo object 规则详情 project_id 是 String 项目ID,获取方式请参见:10.3-获取账号租户ID、项目资源集ID、日志组ID、日志流ID。 缺省值:None 最小长度:32 最大长度:32 rule_id 否 String 接入规则id 表5 AomMappingRuleInfo 参数 是否必选 参数类型 描述 cluster_id 是 String 集群id cluster_name 是 String 集群名称。 deployments_prefix 否 String 日志流前缀。当参数isBatch=true且填写此参数时,则与参数“deployments”拼接为日志流名称,拼接后的日志流名称长度不超过64位。 deployments 是 Array of strings 工作负载(选全部工作负载使用“ALL_DEPLOYMENTS”)。 说明: 自动映射时需要罗列出每个工作负载。 namespace 是 String 命名空间 files 是 Array of CreateAomMappingfilesInfo objects 日志详细(全部日志使用“ALL_FILES”)。 container_name 否 String 容器名称 表6 CreateAomMappingfilesInfo 参数 是否必选 参数类型 描述 file_name 是 String 路径名称。 匹配规则:^/[A-Za-z0-9.*_/-]+|stdout.log| 最多两个** log_stream_info 是 CreateAomMappingLogStreamInfo object 日志流信息日志详细 表7 CreateAomMappingLogStreamInfo 参数 是否必选 参数类型 描述 target_log_group_id 是 String 日志组ID。 缺省值:None 最小长度:36 最大长度:36 target_log_group_name 是 String 日志组名称。 最小长度:1 最大长度:64 target_log_stream_id 是 String 日志流ID。 缺省值:None 最小长度:36 最大长度:36 target_log_stream_name 是 String 日志流名称。 最小长度:1 最大长度:64
  • 响应参数 状态码: 201 表8 响应Body参数 参数 参数类型 描述 [数组元素] Array of CreateAomMappingRuleResp objects 请求响应成功, 成功创建接入配置。 表9 CreateAomMappingRuleResp 参数 参数类型 描述 project_id String 项目id rule_name String 接入规则名称 rule_id String 接入规则id rule_info AomMappingRuleInfoRespBody object 接入规则详情 表10 AomMappingRuleInfoRespBody 参数 参数类型 描述 cluster_id String 集群id cluster_name String 集群名称 deployments_prefix String 日志流前缀 deployments Array of strings 工作负载 namespace String 命名空间 container_name String 容器名称 files Array of AomMappingfilesInfos objects 接入规则详情 表11 AomMappingfilesInfos 参数 参数类型 描述 file_name String 路径名 log_stream_info AomMappingLogStreamInfos object 接入规则详情。 表12 AomMappingLogStreamInfos 参数 参数类型 描述 target_log_group_id String 日志组id target_log_group_name String 目标日志组名称 target_log_stream_id String 日志流id target_log_stream_name String 目标日志流名称 状态码: 400 表13 响应Body参数 参数 参数类型 描述 code String 错误码。 枚举值: LTS.0742 LTS.0743 LTS.0014 LTS.0740 LTS.0744 LTS.0746 details String 调用失败响应信息描述。 枚举值: AOM mapping rule log group id does not exist Operation DB failed AOM mapping rule name already exists AOM mapping rule param validate error AOM mapping rule log stream id does not exist AOM mapping rule log stream name already exist in another log group 状态码: 401 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 403 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId 状态码: 500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码。 枚举值: LTS.0403 error_msg String 调用失败响应信息描述。 枚举值: Invalid projectId
  • URI POST /v2/{project_id}/lts/aom-mapping 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 isBatch 是 Boolean 是否使用自动映射,填写为true的话,可以不用填写容器名、日志流相关参数。
  • 响应示例 状态码: 200 请求响应成功。 { "results" : [ { "create_time" : 1641258099551, "demo_fields" : [ { "content" : "2022-01-03/14:52:28", "field_name" : "field1", "index" : 0, "is_analysis" : true, "type" : "string" }, { "content" : "this", "field_name" : "field2", "index" : 1, "is_analysis" : true, "type" : "string" }, { "content" : "log", "field_name" : "field3", "index" : 2, "is_analysis" : false, "type" : "string" }, { "content" : "is", "field_name" : "field4", "index" : 3, "is_analysis" : false, "type" : "string" }, { "content" : "Error", "field_name" : "field5", "index" : 4, "is_analysis" : false, "type" : "string" }, { "content" : "NO", "field_name" : "field6", "index" : 5, "is_analysis" : false, "type" : "string" }, { "content" : "13测试", "field_name" : "field7", "index" : 6, "is_analysis" : false, "type" : "string" }, { "content" : "286", "field_name" : "field8", "index" : 7, "is_analysis" : false, "type" : "long" } ], "demo_log" : "2022-01-03/14:52:28 this log is Error NO 13测试 286", "id" : "43a8cc7b-b632-4c36-a65d-8150e98219f1", "project_id" : "2a473356cca5487f8373be89xxxxxxxx", "rule" : { "param" : "{\"keyObject\":{\"0\":\"field1\",\"1\":\"field2\",\"2\":\"field3\",\"3\":\"field4\",\"4\":\"field5\",\"5\":\"field6\",\"6\":\"field7\",\"7\":\"field8\"},\"tokenizer\":\" \"}", "type" : "split" }, "demo_label" : "{}", "tag_fields" : [ { "content" : "172.16.10.69", "field_name" : "hostIP", "index" : 0, "is_analysis" : true, "type" : "string" } ], "template_name" : "testSplit13", "template_type" : "split" } ] } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.2017", "error_msg" : "Find struct template failed." }
  • 请求示例 查询当前结构化模板详情 GET https://{endpoint}/v3/{project_id}/lts/struct/customtemplate?id=bc8e3f2c-87fe-4acd-8439-69cdf29251c1 /v3/{project_id}/lts/struct/customtemplate?id=bc8e3f2c-87fe-4acd-8439-69cdf29251c1
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 results Array of StructTemplateModel objects 查询的自定义结构化模板数组 表5 StructTemplateModel 参数 参数类型 描述 project_id String 项目id 最小长度:32 最大长度:32 template_name String 模板名称 最小长度:1 最大长度:64 template_type String 模板类型,regex,json,split,nginx 枚举值: regex json split nginx demo_log String 示例日志 最小长度:1 最大长度:5000 demo_fields Array of DemoField objects 示例字段数组 tag_fields Array of TagFieldNew objects Tag字段数组 rule TemplateRule object 结构化规则对象 demo_label String 示例日志标签 最小长度:0 最大长度:5000 create_time Long 创建时间 最小值:0 最大值:20000000000000 id String 模板id 最小长度:36 最大长度:36 表6 DemoField 参数 参数类型 描述 field_name String 字段名称 最小长度:1 最大长度:64 content String 字段示例内容 最小长度:1 最大长度:5000 type String 字段数据类型。 可选范围:string、long、float 枚举值: string long float is_analysis Boolean 是否开启快速分析 index Integer 手动正则及分隔符方式中字段序号 最小值:0 最大值:200 relation String 描叙多层级json中字段间的层级关系 最小长度:0 最大长度:1000 user_defined_name String json及nginx方式中字段自定义别名 最小长度:1 最大长度:64 表7 TagFieldNew 参数 参数类型 描述 field_name String 字段名称 最小长度:1 最大长度:64 content String 字段示例内容 最小长度:0 最大长度:5000 type String 字段数据类型。 可选范围:string、long、float 枚举值: string long float is_analysis Boolean 是否开启快速分析 index Integer 序号,从0开始 最小值:0 最大值:200 表8 TemplateRule 参数 参数类型 描述 type String 结构化类型,只支持custom_regex,json,split,nginx 枚举值: custom_regex json split nginx param String 具体结构化规则,每种结构化类型都有自己独有的结构,具体结构如下:手动正则为json字符串,包含keyObject对象和regex_rules对象,keyObject内为键值对,键为demo_fields数组中元素的index,值为field_name,regex_rules对象为正则表达式字符串,整体例子为{"keyObject":{"1":"date","2":"num"},"regex_rules":"^(?[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][^/]+)(?:[^ ]* ){8}(?[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]\\d+)"};json方式时param为一个json字符串,包含keyObject对象和layers对象,keyObject内为键值对,键为demo_fields数组中元素的field_name,值为user_defined_name,layers为最大解析层数,当前最大值为4,整体例子为{"keyObject":{"metadata.dimention":"dimention","metadata.value":"","metadata.unit":"","collectionTime":""},"layers":3};分隔符方式时为json字符串,包含keyObject对象和tokenizer对象,keyObject内为键值对,键为demo_fields数组中元素的index,值为field_name,tokenizer对象为所用分隔符,整体例子为{"keyObject":{"0":"field1","1":"field2","2":"field3","3":"field4","4":"field5","5":"field6","6":"field7","7":"field8","8":"field9"},"tokenizer":" "};nginx方式时为json字符串,包含keyObject对象,regex对象,field_names对象及log_format对象,keyObject内为键值对,键为demo_fields数组中元素的field_name,值为user_defined_name,regex为正则表达式字符串,field_names对象为demo_fields数组中各元素的field_name的拼接字符串,每个field_name以','分隔,log_format对象为nginx日志格式化方式,具体方式参考https://support.huaweicloud.com/usermanual-lts/lts_0820.html#lts_0820__section1151119552549进行配置,整体例子为"{"keyObject":{"http_host":"host","remote_addr":"","request_method":"","request_uri":"","time_local":""},"regex":"(\\d+/\\S+/\\d+:\\d+:\\d+:\\d+)\\s+\\S+\\s+(\\S*)\\s+(\\S*)\\s+(\\S*)\\s+\"([^\"])\".","fieldNames":"time_local,remote_addr,request_method,http_host,request_uri","log_format":"log_format upstreaminfo '$time_local $remote_addr $request_method $http_host \"$request_uri\"';"}" 最小长度:1 最大长度:5000 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。 枚举值: Internal Server Error
  • URI GET /v3/{project_id}/lts/struct/customtemplate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 待查询模板id,非必填,不传时返回项目下所有自定义结构化模板 最小长度:36 最大长度:36
  • URI DELETE /v2/{project_id}/lts/alarms/sql-alarm-rule/{sql_alarm_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 sql_alarm_rule_id 是 String Sql告警规则id。 缺省值:None 最小长度:36 最大长度:36
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 请求示例 创建日志收藏 /v1.0/2a473356cca5487f8373be891bffc1cf/lts/favorite { "log_group_id" : "d91fff37-9d10-47f1-85de-c2840724908f", "log_group_name" : "lts-group-sgq1", "log_stream_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c", "log_stream_name" : "lts-topic-xxxxtest", "eps_id" : "0", "favorite_resource_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c", "favorite_resource_type" : "log_stream", "is_global" : true }
  • 响应示例 状态码: 201 创建日志收藏成功 { "create_time" : 1669018970929, "eps_id" : "0", "favorite_resource_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c", "is_global" : true, "favorite_resource_type" : "LOG_STREAM", "log_group_id" : "d91fff37-9d10-47f1-85de-c2840724908f", "log_group_name" : "lts-group-sgq1", "log_stream_id" : "f2fb0a2d-d4cd-4bc9-ac12-93c6d255883c", "log_stream_name" : "lts-topic-xxxxtest", "project_id" : "2a473356cca5487f8373be891bffc1cf" } 状态码: 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.0603", "details" : "group or stream not exist" } } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token Content-Type 是 String 该字段填为:application/json;charset=utf8。 表3 请求Body参数 参数 是否必选 参数类型 描述 eps_id 否 String 企业项目id favorite_resource_id 是 String 收藏资源id favorite_resource_type 是 String 收藏资源类型 log_group_id 是 String 日志组id log_group_name 否 String 日志组名称,日志组名称有误时按照日志组id创建日志收藏 log_stream_id 是 String 日志流id log_stream_name 否 String 日志流名称,日志流名称有误时按照日志流id创建日志收藏 is_global 是 Boolean 是否支持全局化,必填true,否则创建不了日志收藏
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 create_time Integer 创建时间 eps_id String 企业项目id favorite_resource_id String 收藏资源id favorite_resource_type String 收藏资源类型,资源类型为LOG_STREAM。 log_group_id String 日志组id log_group_name String 日志组名称 log_stream_id String 日志流id log_stream_name String 日志流名称 project_id String 项目id is_global Boolean 是否开启日志收藏 状态码: 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
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:自定义策略中授权项定义的内容即为权限。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 start_time 是 String 搜索起始时间(UTC时间,毫秒级)。 end_time 是 String 搜索结束时间(UTC时间,毫秒级)。 sql_expression 否 String 支持SQL语句搜索, 目前支持"GROUP BY", "LIKE"和"WHERE"。默认为"SELECT *"。 最小长度:0 最大长度:100 original_content 否 Boolean 返回内容中是否包含原始日志, 默认为false。 枚举值: false
  • 请求示例 查询结构化日志 POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/struct-content/query 当“sql_expression”参数填写为select * v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/struct-content/query { "start_time" : "1595811590539", "end_time" : "1595811593539", "original_content" : "true", "sql_expression" : "select *" } 当“sql_expression”参数填写为select count(test3), sum(test4) { "start_time" : "1595811590539", "end_time" : "1595811593539", "sql_expression" : "select count(test3), sum(test4)" } 当“sql_expression”参数填写为select count(test3), sum(test4) group by(test1) { "start_time" : "1595811590539", "end_time" : "1595811593539", "sql_expression" : "select count(test3), sum(test4) group by(test1)" }
共100000条