文档首页/ 应用运维管理 AOM/ API参考/ API/ 告警/ 查询消息通知模板列表
更新时间:2025-01-08 GMT+08:00
分享

查询消息通知模板列表

功能介绍

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

消息体的类型(格式)。指定类型为“application/json”。

Enterprise-Project-Id

String

企业项目id。 获取方式请参见:获取企业项目ID

  • 查询单个企业项目下通知消息模板列表,填写企业项目id。

  • 查询所有企业项目下通知消息模板列表,填写“all_granted_eps”。

  • 不填,查询默认企业项目下通知消息模板列表。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of NotificationTemplate objects

消息通知模板列表。

表4 NotificationTemplate

参数

参数类型

描述

create_time

Long

消息通知模板创建时间。

desc

String

消息通知模板描述。

enterprise_project_id

String

消息通知模板所属企业项目id。

locale

String

消息通知模板语言。

modify_time

Long

消息通知模板修改时间。

name

String

消息通知模板名称。

project_id

String

消息通知模板所属项目id。

source

String

消息通知模板来源。

templates

String

消息通知模板内容。

消息通知模板内容为json字符串,具体内容是由下列参数拼接成json数组后转义而来。

名称 是否必选 参数类型 说明
content string 消息模板内容。
subType string 消息模板发送类型,支持:email,sms,webhook。
topic string 邮件主题。
sendType string 当消息模板发送类型为“webhook”时需要指定消息模板格式,支持:HTML、JSON。
verison string 默认为v2。

type

Array of strings

消息通知方式。

请求示例

查询消息通知模板列表

https://{Endpoint}/v2/{project_id}/events/notification/templates

响应示例

状态码: 200

OK 请求响应成功。

[ {
  "create_time" : 1685445932076,
  "desc" : "",
  "enterprise_project_id" : "0",
  "locale" : "zh-cn",
  "modify_time" : 1707011425355,
  "name" : "530en",
  "project_id" : "2a4****6cca****f837****91bf****f",
  "templates" : "[{\"subType\":\"email\",\"version\":\"v2\",\"topic\":\"${region_name}[${event_severity}_${event_type}_${clear_type}]于${starts_at}时间发生告警\",\"content\":\"华为云账号:${domain_name};\\n通知类型:${event_type};\\n事件级别:${event_severity};\\n事件名称:${event_name};\\n发生时间:${starts_at};\\n事件源:${resource_provider};\\n资源类型:${resource_type};\\n资源标识:${resources};\\n可能原因:${alarm_probableCause_zh};\\n附加信息:${message};\\n修复建议:${alarm_fix_suggestion_zh};\\n最新指标值:  ${current_data};\\n${resource_info};\"},{\"subType\":\"sms\",\"version\":\"v2\",\"content\":\"告警名称:${event_name};\\n${resource_info};\\n发生时间:${starts_at};\\n详情:${alarm_url};\\n告警内容:${message};\\n最新指标值:  ${current_data};\\n本消息是由${domain_name}在AOM告警规则中配置;\"},{\"subType\":\"wechat\",\"version\":\"v2\",\"content\":\"告警名称:${event_name};  \\n告警ID:${id};  \\n告警时间:${starts_at};  \\n告警行动规则:${action_rule};  \\n告警级别:${event_severity};  \\n告警内容:${alarm_info};  \\n资源标识:${resources_new};  \\n修复建议:${alarm_fix_suggestion_zh};\"},{\"subType\":\"dingding\",\"version\":\"v2\",\"content\":\"告警名称:${event_name};  \\n告警ID:${id};  \\n告警时间:${starts_at};  \\n告警行动规则:${action_rule};  \\n告警级别:${event_severity};  \\n告警内容:${alarm_info};  \\n资源标识:${resources_new};  \\n修复建议:${alarm_fix_suggestion_zh};\"},{\"subType\":\"webhook\",\"version\":\"v2\",\"content\":\"通知类型:${event_type};\\n事件级别:${event_severity};\\n事件名称:$event.metadata.event_name;\\n发生时间:${starts_at};\\n事件源:$event.metadata.resource_provider;\\n资源类型:$event.metadata.resource_type;\\n资源标识:${resources};\\n可能原因:${alarm_probableCause_zh};\\n附加信息:${message};\\n修复建议:${alarm_fix_suggestion_zh};\\n最新指标值:  ${current_data};\",\"sendType\":\"HTML\"},{\"subType\":\"voice\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"通知类型:${event_type};  \\n事件级别:${event_severity};  \\n事件名称:$event.metadata.event_name;  \\n发生时间:${starts_at};  \\n事件源:$event.metadata.resource_provider;  \\n资源类型:$event.metadata.resource_type;  \\n资源标识:${resources_new};  \\n可能原因:${alarm_probableCause_zh};  \\n附加信息:${message};  \\n修复建议:${alarm_fix_suggestion_zh};\"},{\"subType\":\"espace\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"通知类型:${event_type};  \\n事件级别:${event_severity};  \\n事件名称:$event.metadata.event_name;  \\n发生时间:${starts_at};  \\n事件源:$event.metadata.resource_provider;  \\n资源类型:$event.metadata.resource_type;  \\n资源标识:${resources_new};  \\n可能原因:${alarm_probableCause_zh};  \\n附加信息:${message};  \\n修复建议:${alarm_fix_suggestion_zh};\"},{\"subType\":\"feishu\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"告警名称:${event_name};  \\n告警ID:${id};  \\n告警时间:${starts_at};  \\n告警行动规则:${action_rule};  \\n告警级别:${event_severity};  \\n告警内容:${alarm_info};  \\n资源标识:${resources_new};  \\n修复建议:${alarm_fix_suggestion_zh};\"},{\"subType\":\"welink\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"cascaca\"}]",
  "type" : [ ]
} ]

状态码

状态码

描述

200

OK 请求响应成功。

错误码

请参见错误码

相关文档