查询单个消息模板
功能介绍
该接口用于查询单个通知模板
URI
GET /v2/{project_id}/{domain_id}/lts/events/notification/template/{template_name}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
通知规则名称 |
type |
Array of strings |
通知方式 |
desc |
String |
模板描述 |
source |
String |
模板来源 |
locale |
String |
语言 |
templates |
Array of SubTemplateResBody objects |
模板正文,为一个数组 |
create_time |
Long |
创建时间,为毫秒时间戳 |
modify_time |
Long |
更新时间,为毫秒时间戳 |
project_id |
String |
项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID(lts_api_0006.xml)。 |
参数 |
参数类型 |
描述 |
---|---|---|
sub_type |
String |
模板子类型,例如sms,email |
content |
String |
子模版正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。 |
topic |
String |
邮件主题,只有sub_type=email时生效 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
message |
CodeDetailsRspBody object |
错误内容 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
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" : "en-us", "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告警源:$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" } ], "type" : [ ] }
状态码:401
项目id校验失败
{ "message" : { "code" : "LTS.0001", "details" : "project verify error" } }
状态码:500
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.2018", "error_msg" : "Failed to get notification template." }
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
401 |
项目id校验失败 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。