更新时间:2024-10-28 GMT+08:00

查询消息模板列表

功能介绍

该接口用于查询通知模板列表。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/{domain_id}/lts/events/notification/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

domain_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

Content-Type

String

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

results

Array of NotificationTemplate objects

模板数组

表4 NotificationTemplate

参数

参数类型

描述

name

String

通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改

type

Array of strings

保留字段,非必填

desc

String

模板描述,非必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024

source

String

模板来源,目前必填为LTS,否则会筛选不出来

locale

String

语言,必填,目前可填zh-cn和en-us

templates

Array of SubTemplateResBody objects

模板正文,为一个数组

create_time

Long

创建时间,为毫秒时间戳

modify_time

Long

更新时间,为毫秒时间戳

project_id

String

项目ID,获取方式请参见:获取账号ID、项目ID、日志组ID、日志流ID(lts_api_0006.xml)。

表5 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

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

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

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

错误码

请参见错误码