文档首页/ 云日志服务 LTS/ API参考/ API说明/ 消息模板管理/ 查询单个消息模板
更新时间：2024-12-12 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

最小长度：32

最大长度：32

domain_id

是

String

账号ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：32

最大长度：32

template_name

是

String

template_name

最小长度：1

最大长度：100

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token，获取方式请参见：获取用户Token

最小长度：1000

最大长度：2000

Content-Type

是

String

该字段填为：application/json;charset=UTF-8。

最小长度：30

最大长度：30

响应参数

状态码： 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

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
表4 SubTemplateResBody

参数

参数类型

描述

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

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：8

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

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

错误码

请参见错误码。

父主题： 消息模板管理

相关文档