- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 授权IAM用户使用云日志服务LTS
- 日志管理
-
日志接入
- 日志接入概述
- 使用ICAgent插件采集日志
-
使用云服务接入LTS
- 云服务接入LTS概述
- 应用运维管理AOM接入LTS
- API网关APIG接入LTS
- 云堡垒机CBH接入LTS
- 云防火墙CFW接入LTS
- 云审计服务CTS接入LTS
- 文档数据库服务DDS接入LTS
- 分布式消息服务Kafka版接入LTS
- 数据复制服务DRS接入LTS
- 数据仓库服务GaussDB(DWS)接入LTS
- 弹性负载均衡 ELB接入LTS
- 企业路由器ER接入LTS
- 函数工作流FunctionGraph接入LTS
- 云数据库GaussDB接入LTS
- 图引擎服务GES接入LTS
- 云数据库 TaurusDB接入LTS
- 云数据库GeminiDB接入LTS
- 云数据库GeminiDB Mongo接入LTS
- 云数据库GeminiDB Cassandra接入LTS
- 设备接入IoTDA接入LTS
- AI开发平台ModelArts接入LTS
- MapReduce服务MRS接入LTS
- 云数据库RDS for MySQL接入LTS
- 云数据库RDS for PostgreSQL接入LTS
- 云数据库RDS for SQLServer接入LTS
- 应用与数据集成平台ROMA Connect接入LTS
- 消息通知服务SMN接入LTS
- 安全云脑SecMaster接入LTS
- 对象存储服务OBS接入LTS(邀测)
- 虚拟私有云VPC接入LTS
- Web应用防火墙WAF接入LTS
- 使用API接入LTS
- 跨IAM账号接入LTS
- 使用KAFKA协议上报日志到LTS
- 使用Flume采集器上报日志到LTS
- 日志搜索与分析
- 日志可视化
- 日志告警
- 日志转储
- 日志加工
- LTS配置中心管理
- 查看LTS审计事件
- 最佳实践
- 开发指南
- API参考
- SDK参考
- 常见问题
-
更多文档
- 用户指南(阿布扎比区域)
- API参考(阿布扎比区域)
- 用户指南(巴黎区域)
- API参考(巴黎区域)
- 用户指南(吉隆坡区域)
- API参考(吉隆坡区域)
- 用户指南(安卡拉区域)
- API参考(安卡拉区域)
- 视频帮助
- 通用参考
链接复制成功!
查询消息模板列表
功能介绍
该接口用于查询通知模板列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/{domain_id}/lts/events/notification/templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
domain_id |
是 |
String |
账号ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
results |
Array of NotificationTemplate objects |
模板数组 |
参数 |
参数类型 |
描述 |
---|---|---|
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 枚举值:
|
templates |
Array of SubTemplateResBody objects |
模板正文,为一个数组 |
create_time |
Long |
创建时间,为毫秒时间戳 最小值:0 最大值:1700000000000 |
modify_time |
Long |
更新时间,为毫秒时间戳 最小值:0 最大值:1700000000000 |
project_id |
String |
项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID(lts_api_0006.xml)。 最小长度:32 最大长度:32 |
参数 |
参数类型 |
描述 |
---|---|---|
sub_type |
String |
模板子类型,只支持以下6种类型:sms,dingding,wechat,webhook,email 枚举值: 枚举值:
|
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; 变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。 |
topic |
String |
邮件主题,只有sub_type=email时生效 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 最小长度:8 最大长度:8 |
error_msg |
String |
调用失败响应信息描述。 |
请求示例
查询消息模板列表
GET https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates /v2/{project_id}/{domain_id}/lts/events/notification/templates
响应示例
状态码:200
请求响应成功。
{ "results" : [ { "create_time" : 1701352010150, "desc" : "这是短信测试模式", "locale" : "zh-cn", "modify_time" : 1701352010150, "name" : "15nWzUsOHA", "project_id" : "2a473356cca5487f8373be891bffc1cf", "source" : "LTS", "templates" : [ { "content" : "”这是一个短信测试模板”", "sub_type" : "sms" } ], "type" : [ "" ] }, { "create_time" : 1702021411612, "desc" : "这是短信测试模式", "locale" : "zh-cn", "modify_time" : 1702021411612, "name" : "RZ2ObeluNN", "project_id" : "2a473356cca5487f8373be891bffc1cf", "source" : "LTS", "templates" : [ { "content" : "”这是一个短信测试模板”", "sub_type" : "sms" } ], "type" : [ "" ] } ] }
状态码:500
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.2017", "error_msg" : "Find Alarm rule failed." }
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。