本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云日志服务 LTS/ API参考/ API说明/ 消息模板管理/ 查询单个消息模板

查询单个消息模板

更新时间：2025-04-30 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

查询单个消息通知模板。通过该接口可查询单个消息通知模板的信息，包括模板名称、内容、创建时间等，为您开展模板管理提供精准数据支撑。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/{domain_id}/lts/events/notification/template/{template_name}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方式请参见：获取项目ID、获取账号ID、日志组ID、日志流ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
domain_id	是	String	参数解释：账号ID，获取方式请参见：获取项目ID、获取账号ID、日志组ID、日志流ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
template_name	是	String	参数解释：需要获取的消息模板名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：从IAM服务获取的用户Token，获取方式请参见：获取用户Token。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
Content-Type	是	String	参数解释：该字段填为：application/json;charset=UTF-8。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
name	String	参数解释：通知规则名称，必填。取值范围：只包含汉字、数字、字母、下划线、中划线，不能以下划线等特殊符号开头和结尾，长度为1-100，创建后不可修改。
type	Array of strings	参数解释：保留字段，非必填。取值范围：不涉及。
desc	String	参数解释：模板描述，非必填。取值范围：只含有汉字、数字、字母、下划线不能以下划线开头和结尾，长度为0-1024。
source	String	参数解释：模板来源。取值范围：目前必填为LTS，否则会筛选不出来。
templates	Array of SubTemplateResBody objects	参数解释：模板正文，为一个数组。取值范围：不涉及。
locale	String	参数解释：本地语言代码。取值范围：不涉及。
create_time	Long	参数解释：创建时间（单位为毫秒时间戳）。取值范围：不涉及。
modify_time	Long	参数解释：更新时间（单位为毫秒时间戳）。取值范围：不涉及。
project_id	String	参数解释：项目ID，获取方式请参见：获取项目ID、获取账号ID、日志组ID、日志流ID。取值范围：不涉及。

表4 SubTemplateResBody
参数	参数类型	描述
sub_type	String	参数解释：模板子类型，支持以下类型：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; 告警级别：${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

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：调用失败响应信息描述。取值范围：不涉及。

请求示例

查询指定名称的消息模板。

GET https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/template/{template_name}

/v2/{project_id}/{domain_id}/lts/events/notification/template/{template_name}

响应示例

状态码：200

请求响应成功。

{
  "create_time" : 1702955600631,
  "desc" : "description",
  "locale" : "zh-cn",
  "modify_time" : 1702955600631,
  "name" : "postman-test",
  "project_id" : "2a473356cca5487f8373be891bffc1cf",
  "source" : "LTS",
  "templates" : [ {
    "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" : "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告警源：$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" : "email"
  }, {
    "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" : "voice"
  } ],
  "type" : [ ]
}

状态码：500

表明服务端能被请求访问到，但是服务内部出错。

{
  "error_code" : "LTS.2018",
  "error_msg" : "Failed to get notification template."
}

状态码


状态码	描述
200	请求响应成功。
500	表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题：消息模板管理

上一篇：删除消息模板

下一篇：预览消息模板邮件格式

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问