华为云用户手册

  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • 响应示例 状态码: 200 请求响应成功。 { "id" : "string", "sql" : "string", "title" : "string", "type" : "table", "log_group_id" : "string", "log_group_name" : "string", "log_stream_id" : "string", "log_stream_name" : "string", "config" : { "canSort" : true, "canSearch" : true, "pageSize" : 0 } }
  • URI GET /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/charts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 log_group_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36 log_stream_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询游标,初始传入0,后续从上一次的返回值中获取。 最小值:0 最大值:1024 limit 否 Integer 每页数据量,最大值为100。 最小值:0 最大值:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String id 最小长度:36 最大长度:36 sql String sql语句 最小长度:1 最大长度:1024 title String 图表名称 最小长度:1 最大长度:64 type String 图表类型 枚举值: table bar line pie number log_group_id String 日志组id 最小长度:36 最大长度:36 log_group_name String 日志组名称 最小长度:1 最大长度:64 log_stream_id String 日志组id 最小长度:32 最大长度:32 log_stream_name String 日志流名称 最小长度:1 最大长度:64 config ChartConfig object 图表配置详情 表5 ChartConfig 参数 参数类型 描述 canSort Boolean 是否开启排序 canSearch Boolean 是否开启搜索 pageSize Integer 每页显示数量 最小值:0 最大值:100
  • 响应示例 状态码: 200 Delete result { "create_time" : 1694423493108, "id" : "f5b6b235-48a2-473c-a1fa-4ddba9ca86d8", "log_mapping_config" : [ { "log_stream_config" : [ { "source_log_stream_id" : "55b33967-1971-4521-bf5a-e53e981f3d08", "target_log_stream_eps_id" : "0", "target_log_stream_id" : "ebaf8e21-dba6-4697-99b2-6811f109d03f", "target_log_stream_name" : "stdout-test_huiju", "target_log_stream_ttl" : 180 } ], "source_log_group_id" : "c59e2705-5bbf-4f55-8861-92d4e7e7d33f", "target_log_group_id" : "5adb3025-e663-4cf4-bcf7-7340e79cdbd3", "target_log_group_name" : "k8s-log-test_paas_apm_z00418070_01" }, { "log_stream_config" : [ { "source_log_stream_id" : "b77c9164-b411-42f4-9d4c-2ca7115496b7", "target_log_stream_eps_id" : "0", "target_log_stream_id" : "7120856a-bf15-4f92-8f08-b64bba8c81b1", "target_log_stream_name" : "stdout-test_huiju", "target_log_stream_ttl" : 180 } ], "source_log_group_id" : "77f7e0fc-0ad0-4af0-b1e9-198007d5f993", "target_log_group_id" : "f8076177-c903-4dcf-85d5-dca9d13e591e", "target_log_group_name" : "k8s-log-stest_paas_apm_z00418070_01" } ], "management_account_id" : "115ba1c5fec44839820795ebefe25f2a", "management_project_id" : "a5baef478e6840dc9f454bbc00c996c6", "member_account_id" : "1d26cc8c86a840e28a4f8d0d07852f1d", "member_project_id" : "2a473356cca5487f8373be891bffc1cf", "organization_id" : "o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf", "status" : "done" } 状态码: 400 Error response ""
  • URI GET /v1/{project_id}/lts/log-converge-config/{member_account_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID member_account_id 是 String 成员帐户ID
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String ID member_account_id String 组织成员账号id member_project_id String 管理员或者委托管理员项目id create_time Long 创建时间 update_time Long 更新时间 status String creating: 配置创建中 done:配置创建完成 枚举值: creating done organization_id String 组织id management_account_id String 管理员或者委托管理员账号id management_project_id String 管理员项目id version String 版本 log_mapping_config Array of LogMappingConfig objects 日志汇聚配置 表4 LogMappingConfig 参数 参数类型 描述 source_log_group_id String 源日志组ID target_log_group_id String 目标日志组ID target_log_group_name String 目标日志组名称 log_stream_config Array of LogMappingStreamInfo objects 日志流配置 表5 LogMappingStreamInfo 参数 参数类型 描述 source_log_stream_id String 源日志流ID target_log_stream_id String 目标日志流ID target_log_stream_name String 目标日志流名称 target_log_stream_eps_id String 目标日志流EPS ID target_log_stream_ttl Integer 目标日志流ttl保存时间,单位时间(天). 最小值:1 最大值:30 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 results Array of results objects 获取组织成员日志组日志流结果 表4 results 参数 参数类型 描述 log_group_id String 日志组ID log_group_name String 日志组名称 log_streams Array of log_streams objects 日志流 表5 log_streams 参数 参数类型 描述 log_stream_name String 日志流名称 log_stream_id String 日志流ID 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应示例 状态码: 200 组织成员日志组日志流 { "results" : [ { "log_group_name" : "cuiss", "log_streams" : [ { "log_stream_name" : "wjyTest", "log_stream_id" : "d67124ed-b4bd-4d89-8646-5905c2eeaa62" } ] "log_group_id" : "d6c04fe9-170a-4d98-94e6-7844f47bd0b8" } ] }
  • 响应示例 状态码: 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。 表明服务端能被请求访问到,但是服务内部出错。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of strings 请求响应成功, 成功删除接入配置。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 错误码。 枚举值: LTS.0744 LTS.0014 LTS.0745 details String 调用失败响应信息描述。 枚举值: AOM mapping rule param validate error Operation DB failed AOM mapping rule id is invalid 状态码: 401 表6 响应Body参数 参数 参数类型 描述 massage Massage401 object 接口调用信息。 表7 Massage401 参数 参数类型 描述 code String 错误码。 枚举值: LTS.0001 details String 调用失败响应信息描述。 枚举值: project verify error 状态码: 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
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token 缺省值:None 最小长度:1000 最大长度:2000 Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30
  • URI DELETE /v2/{project_id}/lts/aom-mapping 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 id 是 String 接入规则ID。 缺省值:None 最小长度:36 最大长度:36
  • 响应示例 状态码: 200 创建日志接入请求响应成功 { "access_config_detail" : { "containerNameRegex" : "container-1", "format" : { "single" : { "mode" : "system", "value" : "1678969382000" } }, "namespaceRegex" : "default", "pathType" : "container_stdout", "paths" : [ ], "podNameRegex" : "mystdout-6d7458d77c-rhjcc", "stderr" : true, "stdout" : true }, "access_config_id" : "03b16999-95cf-453b-9668-7aa1fafa564e", "access_config_name" : "myapinew32Y", "access_config_tag" : [ { "key" : "my01", "value" : "001" }, { "key" : "my02", "value" : "002" } ], "access_config_type" : "K8S_CCE", "binary_collect" : true, "create_time" : 1685626665176, "log_info" : { "log_group_id" : "9575cb24-290c-478e-a5db-88d6d1dc513b", "log_group_name" : "my-group", "log_stream_id" : "eea03c27-e041-4bec-bd03-6afa10a6561a", "log_stream_name" : "lts-topic-cceapi" }, "log_split" : true } 状态码: 400 非法请求 建议根据error_msg直接修改该请求。 { "error_code" : "LTS.1807", "error_msg" : "Invalid access config name" } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错。 { "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
  • 请求示例 创建日志接入(CCE接入) POST https://{endpoint}/v3/{project_id}/lts/access-config { "access_config_name" : "myapinew322", "access_config_type" : "K8S_CCE", "access_config_detail" : { "pathType" : "CONTAINER_STDOUT", "stdout" : "true", "stderr" : "false", "format" : { "single" : { "mode" : "system", "value" : "1678969382000" } }, "namespaceRegex" : "default", "podNameRegex" : "abc", "containerNameRegex" : "my", "includeLabels" : { "a" : "1" }, "excludeLabels" : { "b" : "2" }, "logLabels" : { "c" : "3" }, "includeK8sLabels" : { "d" : "4" }, "excludeK8sLabels" : { "e" : "5" }, "logK8s" : { "f" : "6" }, "includeEnvs" : { "g" : "7" }, "excludeEnvs" : { "h" : "8" }, "logEnvs" : { "i" : "9" } }, "log_info" : { "log_group_id" : "9575cb24-290c-478e-a5db-88d6d1dc513b", "log_stream_id" : "3581bee9-8698-476e-a0ba-b0f310ed99cf" }, "host_group_info" : { "host_group_id_list" : [ "12b0bbd1-4eda-456b-a641-647aa66bdeab" ] }, "access_config_tag" : [ { "key" : "my01", "value" : "001" }, { "key" : "my02", "value" : "002" } ], "binary_collect" : "false", "log_split" : "false" } 创建日志接入(ECS接入) POST https://{endpoint}/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" } ] }
  • 响应示例 状态码: 200 查询sql历史成功 { "results" : [ { "last_use_time" : 1669689650936, "sql_statement" : "SELECT *" }, { "last_use_time" : 1666775421613, "sql_statement" : "select count(\"t\") as pv" }, { "last_use_time" : 1666661494805, "sql_statement" : "SELECT count(\"time\")" }, { "last_use_time" : 1666598233252, "sql_statement" : "SELECT count(\"t\") as pv" }, { "last_use_time" : 1666598226763, "sql_statement" : "SELECT count(\"t\") " }, { "last_use_time" : 1666598222298, "sql_statement" : "SELECT count(\"t\") as pv" }, { "last_use_time" : 1666598221585, "sql_statement" : "SELECT count(\"t\") as p" }, { "last_use_time" : 1666598220276, "sql_statement" : "SELECT count(\"t\") as " }, { "last_use_time" : 1666598212453, "sql_statement" : "SELECT count(\"t\")" } ] } 状态码: 400 BadRequest 非法请求建议根据error_msg直接修改该请求 { "message" : { "code" : "LTS.0603", "details" : "group or stream not exist" } } 状态码: 500 表明服务端能被请求访问到,但是服务内部出错 { "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }
  • URI GET /v2/{project_id}/lts/history-sql 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String '项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID' 缺省值:None 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 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
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 results Array of QuertHistorySQLResultsBody objects 响应结果。 表5 QuertHistorySQLResultsBody 参数 参数类型 描述 last_use_time Long 上次修改时间,时间戳,毫秒数 sql_statement String 历史sql语句 状态码: 400 表6 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表7 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 details String 错误描述 最小长度:2 最大长度:512 状态码: 500 表8 响应Body参数 参数 参数类型 描述 message ErrorMessagebody object 错误信息body体 表9 ErrorMessagebody 参数 参数类型 描述 code String 错误码 最小长度:8 最大长度:36 details String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token,获取方式请参见:获取用户Token Content-Type 是 String 该字段填为:application/json;charset=UTF-8。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String ID member_account_id 是 String 组织成员账号id member_project_id 否 String 组织成员项目id create_time 否 Long 创建时间 update_time 否 Long 更新时间 status 否 String 状态 organization_id 是 String 组织id management_account_id 是 String 管理员或者委托管理员账号id management_project_id 是 String 管理员或者委托管理员项目id version 否 String 版本 log_mapping_config 否 Array of LogMappingConfig objects 日志汇聚配置 表4 LogMappingConfig 参数 是否必选 参数类型 描述 source_log_group_id 是 String 源日志组ID target_log_group_id 否 String 目标日志组ID target_log_group_name 是 String 目标日志组名称 log_stream_config 否 Array of LogMappingStreamInfo objects 日志流配置 表5 LogMappingStreamInfo 参数 是否必选 参数类型 描述 source_log_stream_id 是 String 源日志流ID target_log_stream_id 否 String 目标日志流ID target_log_stream_name 是 String 目标日志流名称 target_log_stream_eps_id 否 String 目标日志流EPS ID target_log_stream_ttl 是 Integer 目标日志流ttl保存时间,单位时间(天). 最小值:1 最大值:30
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/lts/log-converge-config { "management_account_id" : "115ba1c5fec44839820795ebefe25f2a", "management_project_id" : "a5baef478e6840dc9f454bbc00c996c6", "organization_id" : "o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf", "member_account_id" : "1d26cc8c86a840e28a4f8d0d07852f1d", "log_mapping_config" : [ { "source_log_group_id" : "9445b280-19ca-4691-aef3-5d84e0bf1490", "target_log_group_id" : "", "target_log_group_name" : "lts-liyan_paas_apm_lwx1259998", "log_stream_config" : [ { "source_log_stream_id" : "0a1a7510-7f83-48af-8fc2-0d56de6aa5fd", "target_log_stream_eps_id" : "", "target_log_stream_id" : "", "target_log_stream_name" : "lts_liyan_paas_apm_lwx1259998_01", "target_log_stream_ttl" : 180 } ] } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 results Array of NotificationTemplate objects 模板数组 表5 NotificationTemplate 参数 参数类型 描述 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 模板正文,为一个数组 create_time Long 创建时间,为毫秒时间戳 最小值:0 最大值:1700000000000 modify_time Long 更新时间,为毫秒时间戳 最小值:0 最大值:1700000000000 project_id String 项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID(https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 最小长度:32 最大长度:32 表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; 说明: 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • URI GET /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 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询游标,初始传入0,后续从上一次的返回值中获取 最小值:0 最大值:1024 limit 否 Integer 每页数据量,最大值为100 最小值:0 最大值:100
  • 请求示例 根据告警ID删除活动告警 POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear { "events" : [ { "metadata" : { "event_type" : "alarm", "event_id" : "1", "lts_alarm_type" : "keywords/sql", "resource_type" : "日志组/流", "event_severity" : "Critical", "resource_id" : "lts-group-demo/lts-topic-demo", "event_name" : "demo", "resource_provider" : "LTS" }, "starts_at" : 1629947408497 } ] }
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 events 是 Array of Event objects 主题信息 表4 Event 参数 是否必选 参数类型 描述 metadata 是 Metadata object 告警信息 最小长度:0 最大长度:2048 starts_at 是 Long 告警产生时间(时间戳) 最小值:0 最大值:32 表5 Metadata 参数 是否必选 参数类型 描述 event_type 是 String 告警类型 最小长度:1 最大长度:1024 event_id 是 String 告警id 最小长度:1 最大长度:1024 event_severity 是 String 告警级别 最小长度:1 最大长度:1024 event_name 是 String 告警名称 最小长度:1 最大长度:1024 resource_type 是 String 资源类型 最小长度:1 最大长度:1024 resource_id 是 String 日志组/流名称 最小长度:1 最大长度:1024 resource_provider 是 String 告警源 最小长度:1 最大长度:1024 lts_alarm_type 是 String 告警规则类型(SQL/关键词) 最小长度:1 最大长度:100
  • URI POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32 domain_id 是 String 项目ID,账号ID,日志组ID、日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 缺省值:None 最小长度:32 最大长度:32
  • 响应参数 状态码: 200 表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 SubTemplateResBody objects 模板正文,为一个数组 create_time Long 创建时间,为毫秒时间戳 最小值:0 最大值:1700000000000 modify_time Long 更新时间,为毫秒时间戳 最小值:0 最大值:1700000000000 project_id String 项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID(https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 最小长度:32 最大长度:32 表4 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; 说明: 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:8 error_msg String 调用失败响应信息描述。
  • URI GET /v2/{project_id}/{domain_id}/lts/events/notification/template/{template_name} 表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 template_name 是 String template_name 最小长度:1 最大长度:100
  • 创建日志组 接口相关信息 URI格式:POST /v2/{project_id}/groups 请求示例 POST https://{endpoint}/v2/{project_id}/groups {endpoint}信息请从终端节点获取。 Body: { "log_group_name": "lts-group-01nh", "ttl_in_days": 7 } 响应示例 { "log_group_id" : "string" }
  • 查询日志组 接口相关信息 URI格式:GET /v2/{project_id}/groups 请求示例 GET https://{endpoint}/v2/{project_id}/groups {endpoint}信息请从终端节点获取。 响应示例 {"log_groups" : [{"creation_time" : number,"log_group_name" : "string","log_group_id" : "string","ttl_in_days" : 1}]}
共100000条