文档中心

云监控

通知模板

ListNotifyTemplates

ListNotifyTemplates

查询通知模板列表。

请求说明

请求方式：POST

请求地址：https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListNotifyTemplates&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListNotifyTemplates	接口名称。当前 API 的名称为 ListNotifyTemplates。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
Name	String	否	template-demo	通知模版名称。字符串形式，支持中文、英文大小写和特殊字符。不能以数字、中划线-，特殊字符开头。长度限制为 1～128 字符。
Ids	Array of String	否	189828***00	通知模版 ID。
Types	Array of String	否	metric	通知模版类型，取值： metric：告警通知模版。 event：事件通知模版。
Channels	Array of String	否	email	通知渠道，取值： email：邮箱 sms：短信 phone：电话 lark：飞书 dingtalk：钉钉 wecom：企业微信 slack：Slack api：回调地址
PageNumber	Integer	否	1	分页查询参数，用于设置当前页码。默认值为 1。实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
PageSize	Integer	否	30	分页查询参数，用于设置每页行数。默认值为 30。

请求示例

返回参数

参数	类型	示例值	描述
Data	Array of NotifyTemplate	-	通知模版详情。

NotifyTemplate

参数	类型	示例值	描述
Id	String	189828***00	通知模版 ID。
Name	String	template-demo	通知模版名称。
Description	String	this is a template-demo	通知模版描述信息。
Type	String	metric	通知模版类型，取值： metric：告警通知模版。 event：事件通知模版。
Channel	String	email	通知渠道，取值： email：邮箱 sms：短信 phone：电话 lark：飞书 dingtalk：钉钉 wecom：企业微信 slack：Slack api：回调地址
Title	String	【{{ .Level \| translate "Level" "zh" }}】【{{ translate "Type" "zh" .Type }}】平台账户{{ .AccountName }}({{ .AccountId }})的告警策略"{{ .RuleName }}"{{ if (contains "Recovered" .Type) }}恢复正常{{ else }}发生{{ .Level \| translate "Level" "zh" }}级别告警{{ end }}	通知模版的标题。
Content	String	告警信息：告警类型：{{ .Type }} 账号名称：{{ .AccountName }} 账号 ID：{{ .AccountId }} 告警策略名称：{{ .RuleName }} 告警策略 ID：{{ .RuleId }} 告警策略详情：{{ .RuleURL }}	通知模版的内容。

返回示例

错误码

本接口无特有的错误码。更多信息请参见错误码。

最近更新时间：2026.08.11 20:28:02

这个页面对您有帮助吗？

有用

有用

无用

无用