文档中心

云监控

通知模板

ListDefaultNotifyTemplates

查询默认通知模板列表。

请求说明

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListDefaultNotifyTemplates	接口名称。当前 API 的名称为 ListDefaultNotifyTemplates。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
Type	String	是	metric	通知模版类型，取值： metric：告警通知模版。 event：事件通知模版。
Channels	Array of String	否	email	通知渠道，取值： email：邮箱 sms：短信 phone：电话 lark：飞书 dingtalk：钉钉 wecom：企业微信 slack：Slack api：回调地址
Language	String	否	zh	通知模版的语言，取值： zh：中文 en：英文

请求示例

POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListDefaultNotifyTemplates&Version=2018-01-01​
Content-Type: application/json​
{​
    "Type": "metric",​
    "Channels": [​
        "email"​
    ],​
    "Language": "zh"​
}​

返回参数

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

DefaultNotifyTemplate

参数	类型	示例值	描述
Type	String	alert	通知模版类型，取值： alert：告警通知模版。 event：事件通知模版。
Channel	String	email	通知渠道，取值： email：邮箱 sms：短信 phone：电话 lark：飞书 dingtalk：钉钉 wecom：企业微信 slack：Slack api：回调地址
Language	String	zh	通知模版的语言，取值： zh：中文 en：英文
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 }}	通知模版的内容。

返回示例

{​
    "ResponseMetadata": {​
        "Action": "ListDefaultNotifyTemplates",​
        "Region": "cn-beijing",​
        "Service": "cloudmonitor",​
        "Version": "2018-01-01",​
        "RequestId": "20230604110420****100232280022D31"​
    },​
    "Result": {​
        "Data": [​
            {​
                "Type": "alert",​
                "Channel": "email",​
                "Language": "zh",​
                "Title": "【{{ .Level | translate \"Level\" \"zh\" }}】【{{ translate \"Type\" \"zh\" .Type }}】平台账户{{ .AccountName }}({{ .AccountId }})的告警策略\"{{ .RuleName }}\"{{ if (contains \"Recovered\" .Type) }}恢复正常{{ else }}发生{{ .Level | translate \"Level\" \"zh\" }}级别告警{{ end }}",​
                "Content": "**告警信息**：\n\n告警类型：{{ .Type }}\n账号名称：{{ .AccountName }}\n账号 ID：{{ .AccountId }}\n告警策略名称：{{ .RuleName }}\n告警策略 ID：{{ .RuleId }}\n告警策略详情：{{ .RuleURL }}"​
            }​
        ]​
    }​
}​

错误码

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

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

这个页面对您有帮助吗？

有用

无用