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

新增消息通知模板 - CreateNotificationTemplate

功能介绍

该接口用于新增消息通知模板。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    aom:notificationTemplate:create

    Write

    -

    -

    -

    -

URI

POST /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。

  • 不填,新增默认企业项目下通知消息模板。

表3 请求Body参数

参数

是否必选

参数类型

描述

desc

String

消息通知模板描述。

locale

String

消息通知模板语言。

name

String

消息通知模板名称。

templates

String

消息通知模板内容。

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

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

source

String

消息通知模板类型:

  • 不填:表示指标或事件模板

  • LTS:表示日志模板

响应参数

状态码:204

No Content 表示请求成功,但没有内容返回。

请求示例

新增消息通知模板的名称为test2的消息通知模板

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

{
  "desc" : "",
  "locale" : "en-us",
  "name" : "txytst2",
  "templates" : "[{\"subType\":\"email\",\"version\":\"v2\",\"topic\":\"${region_name}[${event_severity}_${event_type}_${clear_type}] have a new alert at ${starts_at}.\",\"content\":\"\\nAlarm Name:${event_name_alias};\\nAlarm ID:${id};\\nOccurred:${starts_at};\\nEvent Severity:${event_severity};\\nAlarm Info:${alarm_info};\\nResource Identifier:${resources_new};\\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"sms\",\"version\":\"v2\",\"content\":\"\\nAlarm Name:${event_name_alias};\\nAlarm ID:${id};\\nOccurred:${starts_at};\\nEvent Severity:${event_severity};\\nAlarm Info:${alarm_info};\\nResource Identifier:${resources_new};\\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"wechat\",\"version\":\"v2\",\"content\":\"> **Alarm Name:** ${event_name_alias}  \\n> **Alarm ID:** ${id}  \\n> **Occurred:** ${starts_at}  \\n> **Event Severity:** ${event_severity}  \\n> **Alarm Info:** ${alarm_info}  \\n> **Resource Identifier:** ${resources_new}  \\n> **Suggestion:** ${alarm_fix_suggestion_zh}\"},{\"subType\":\"dingding\",\"version\":\"v2\",\"content\":\"> **Alarm Name:** ${event_name_alias}  \\n\\n> **Alarm ID:** ${id}  \\n\\n> **Occurred:** ${starts_at}  \\n\\n> **Event Severity:** ${event_severity}  \\n\\n> **Alarm Info:** ${alarm_info}  \\n\\n> **Resource Identifier:** ${resources_new}  \\n\\n> **Suggestion:** ${alarm_fix_suggestion_zh}\",\"sendType\":\"HTML\"},{\"subType\":\"webhook\",\"version\":\"v2\",\"content\":\"Notification Type:${event_type};\\nSeverity:${event_severity};\\nName:$event.metadata.event_name_alias;\\nOccurred:${starts_at};\\nSource:$event.metadata.resource_provider;\\nResource Type:$event.metadata.resource_type;\\nResource Identifier:${resources_new};\\nPossible Cause:${alarm_probableCause_zh};\\nAdditional Info:${message};\\nSuggestion:${alarm_fix_suggestion_zh};\",\"sendType\":\"HTML\"},{\"subType\":\"voice\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"Notification Type:${event_type};  \\nSeverity:${event_severity};  \\nName:$event.metadata.event_name_alias;  \\nOccurred:${starts_at};  \\nSource:$event.metadata.resource_provider;  \\nResource Type:$event.metadata.resource_type;  \\nResource Identifier:${resources_new};  \\nPossible Cause:${alarm_probableCause_zh};  \\nAdditional Info:${message};  \\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"espace\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"Notification Type:${event_type};  \\nSeverity:${event_severity};  \\nName:$event.metadata.event_name_alias;  \\nOccurred:${starts_at};  \\nSource:$event.metadata.resource_provider;  \\nResource Type:$event.metadata.resource_type;  \\nResource Identifier:${resources_new};  \\nPossible Cause:${alarm_probableCause_zh};  \\nAdditional Info:${message};  \\nSuggestion:${alarm_fix_suggestion_zh};\"},{\"subType\":\"feishu\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"**Alarm Name:** ${event_name_alias}  \\n\\n**Alarm ID:** ${id}  \\n\\n**Occurred:** ${starts_at}  \\n\\n**Event Severity:** ${event_severity}  \\n\\n**Alarm Info:** ${alarm_info}  \\n\\n**Resource Identifier:** ${resources_new}  \\n\\n**Suggestion:** ${alarm_fix_suggestion_zh}\"},{\"subType\":\"welink\",\"version\":\"v2\",\"topic\":\"\",\"content\":\"\\nAlarm Name:${event_name_alias};\\nAlarm ID:${id};\\nOccurred:${starts_at};\\nEvent Severity:${event_severity};\\nAlarm Info:${alarm_info};\\nResource Identifier:${resources_new};\\nSuggestion:${alarm_fix_suggestion_zh};\"}]"
}

响应示例

SDK代码示例

SDK代码示例如下。

新增消息通知模板的名称为test2的消息通知模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.aom.v2.region.AomRegion;
import com.huaweicloud.sdk.aom.v2.*;
import com.huaweicloud.sdk.aom.v2.model.*;


public class CreateNotificationTemplateSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateNotificationTemplateRequest request = new CreateNotificationTemplateRequest();
        AddNotificationTemplate body = new AddNotificationTemplate();
        body.withTemplates("[{"subType":"email","version":"v2","topic":"${region_name}[${event_severity}_${event_type}_${clear_type}] have a new alert at ${starts_at}.","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"sms","version":"v2","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"wechat","version":"v2","content":"> **Alarm Name:** ${event_name_alias}  \n> **Alarm ID:** ${id}  \n> **Occurred:** ${starts_at}  \n> **Event Severity:** ${event_severity}  \n> **Alarm Info:** ${alarm_info}  \n> **Resource Identifier:** ${resources_new}  \n> **Suggestion:** ${alarm_fix_suggestion_zh}"},{"subType":"dingding","version":"v2","content":"> **Alarm Name:** ${event_name_alias}  \n\n> **Alarm ID:** ${id}  \n\n> **Occurred:** ${starts_at}  \n\n> **Event Severity:** ${event_severity}  \n\n> **Alarm Info:** ${alarm_info}  \n\n> **Resource Identifier:** ${resources_new}  \n\n> **Suggestion:** ${alarm_fix_suggestion_zh}","sendType":"HTML"},{"subType":"webhook","version":"v2","content":"Notification Type:${event_type};\nSeverity:${event_severity};\nName:$event.metadata.event_name_alias;\nOccurred:${starts_at};\nSource:$event.metadata.resource_provider;\nResource Type:$event.metadata.resource_type;\nResource Identifier:${resources_new};\nPossible Cause:${alarm_probableCause_zh};\nAdditional Info:${message};\nSuggestion:${alarm_fix_suggestion_zh};","sendType":"HTML"},{"subType":"voice","version":"v2","topic":"","content":"Notification Type:${event_type};  \nSeverity:${event_severity};  \nName:$event.metadata.event_name_alias;  \nOccurred:${starts_at};  \nSource:$event.metadata.resource_provider;  \nResource Type:$event.metadata.resource_type;  \nResource Identifier:${resources_new};  \nPossible Cause:${alarm_probableCause_zh};  \nAdditional Info:${message};  \nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"espace","version":"v2","topic":"","content":"Notification Type:${event_type};  \nSeverity:${event_severity};  \nName:$event.metadata.event_name_alias;  \nOccurred:${starts_at};  \nSource:$event.metadata.resource_provider;  \nResource Type:$event.metadata.resource_type;  \nResource Identifier:${resources_new};  \nPossible Cause:${alarm_probableCause_zh};  \nAdditional Info:${message};  \nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"feishu","version":"v2","topic":"","content":"**Alarm Name:** ${event_name_alias}  \n\n**Alarm ID:** ${id}  \n\n**Occurred:** ${starts_at}  \n\n**Event Severity:** ${event_severity}  \n\n**Alarm Info:** ${alarm_info}  \n\n**Resource Identifier:** ${resources_new}  \n\n**Suggestion:** ${alarm_fix_suggestion_zh}"},{"subType":"welink","version":"v2","topic":"","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"}]");
        body.withName("txytst2");
        body.withLocale("en-us");
        body.withDesc("");
        request.withBody(body);
        try {
            CreateNotificationTemplateResponse response = client.createNotificationTemplate(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

新增消息通知模板的名称为test2的消息通知模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v2.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateNotificationTemplateRequest()
        request.body = AddNotificationTemplate(
            templates="[{"subType":"email","version":"v2","topic":"${region_name}[${event_severity}_${event_type}_${clear_type}] have a new alert at ${starts_at}.","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"sms","version":"v2","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"wechat","version":"v2","content":"> **Alarm Name:** ${event_name_alias}  \n> **Alarm ID:** ${id}  \n> **Occurred:** ${starts_at}  \n> **Event Severity:** ${event_severity}  \n> **Alarm Info:** ${alarm_info}  \n> **Resource Identifier:** ${resources_new}  \n> **Suggestion:** ${alarm_fix_suggestion_zh}"},{"subType":"dingding","version":"v2","content":"> **Alarm Name:** ${event_name_alias}  \n\n> **Alarm ID:** ${id}  \n\n> **Occurred:** ${starts_at}  \n\n> **Event Severity:** ${event_severity}  \n\n> **Alarm Info:** ${alarm_info}  \n\n> **Resource Identifier:** ${resources_new}  \n\n> **Suggestion:** ${alarm_fix_suggestion_zh}","sendType":"HTML"},{"subType":"webhook","version":"v2","content":"Notification Type:${event_type};\nSeverity:${event_severity};\nName:$event.metadata.event_name_alias;\nOccurred:${starts_at};\nSource:$event.metadata.resource_provider;\nResource Type:$event.metadata.resource_type;\nResource Identifier:${resources_new};\nPossible Cause:${alarm_probableCause_zh};\nAdditional Info:${message};\nSuggestion:${alarm_fix_suggestion_zh};","sendType":"HTML"},{"subType":"voice","version":"v2","topic":"","content":"Notification Type:${event_type};  \nSeverity:${event_severity};  \nName:$event.metadata.event_name_alias;  \nOccurred:${starts_at};  \nSource:$event.metadata.resource_provider;  \nResource Type:$event.metadata.resource_type;  \nResource Identifier:${resources_new};  \nPossible Cause:${alarm_probableCause_zh};  \nAdditional Info:${message};  \nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"espace","version":"v2","topic":"","content":"Notification Type:${event_type};  \nSeverity:${event_severity};  \nName:$event.metadata.event_name_alias;  \nOccurred:${starts_at};  \nSource:$event.metadata.resource_provider;  \nResource Type:$event.metadata.resource_type;  \nResource Identifier:${resources_new};  \nPossible Cause:${alarm_probableCause_zh};  \nAdditional Info:${message};  \nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"feishu","version":"v2","topic":"","content":"**Alarm Name:** ${event_name_alias}  \n\n**Alarm ID:** ${id}  \n\n**Occurred:** ${starts_at}  \n\n**Event Severity:** ${event_severity}  \n\n**Alarm Info:** ${alarm_info}  \n\n**Resource Identifier:** ${resources_new}  \n\n**Suggestion:** ${alarm_fix_suggestion_zh}"},{"subType":"welink","version":"v2","topic":"","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"}]",
            name="txytst2",
            locale="en-us",
            desc=""
        )
        response = client.create_notification_template(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

新增消息通知模板的名称为test2的消息通知模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateNotificationTemplateRequest{}
	descAddNotificationTemplate:= ""
	request.Body = &model.AddNotificationTemplate{
		Templates: "[{"subType":"email","version":"v2","topic":"${region_name}[${event_severity}_${event_type}_${clear_type}] have a new alert at ${starts_at}.","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"sms","version":"v2","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"wechat","version":"v2","content":"> **Alarm Name:** ${event_name_alias}  \n> **Alarm ID:** ${id}  \n> **Occurred:** ${starts_at}  \n> **Event Severity:** ${event_severity}  \n> **Alarm Info:** ${alarm_info}  \n> **Resource Identifier:** ${resources_new}  \n> **Suggestion:** ${alarm_fix_suggestion_zh}"},{"subType":"dingding","version":"v2","content":"> **Alarm Name:** ${event_name_alias}  \n\n> **Alarm ID:** ${id}  \n\n> **Occurred:** ${starts_at}  \n\n> **Event Severity:** ${event_severity}  \n\n> **Alarm Info:** ${alarm_info}  \n\n> **Resource Identifier:** ${resources_new}  \n\n> **Suggestion:** ${alarm_fix_suggestion_zh}","sendType":"HTML"},{"subType":"webhook","version":"v2","content":"Notification Type:${event_type};\nSeverity:${event_severity};\nName:$event.metadata.event_name_alias;\nOccurred:${starts_at};\nSource:$event.metadata.resource_provider;\nResource Type:$event.metadata.resource_type;\nResource Identifier:${resources_new};\nPossible Cause:${alarm_probableCause_zh};\nAdditional Info:${message};\nSuggestion:${alarm_fix_suggestion_zh};","sendType":"HTML"},{"subType":"voice","version":"v2","topic":"","content":"Notification Type:${event_type};  \nSeverity:${event_severity};  \nName:$event.metadata.event_name_alias;  \nOccurred:${starts_at};  \nSource:$event.metadata.resource_provider;  \nResource Type:$event.metadata.resource_type;  \nResource Identifier:${resources_new};  \nPossible Cause:${alarm_probableCause_zh};  \nAdditional Info:${message};  \nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"espace","version":"v2","topic":"","content":"Notification Type:${event_type};  \nSeverity:${event_severity};  \nName:$event.metadata.event_name_alias;  \nOccurred:${starts_at};  \nSource:$event.metadata.resource_provider;  \nResource Type:$event.metadata.resource_type;  \nResource Identifier:${resources_new};  \nPossible Cause:${alarm_probableCause_zh};  \nAdditional Info:${message};  \nSuggestion:${alarm_fix_suggestion_zh};"},{"subType":"feishu","version":"v2","topic":"","content":"**Alarm Name:** ${event_name_alias}  \n\n**Alarm ID:** ${id}  \n\n**Occurred:** ${starts_at}  \n\n**Event Severity:** ${event_severity}  \n\n**Alarm Info:** ${alarm_info}  \n\n**Resource Identifier:** ${resources_new}  \n\n**Suggestion:** ${alarm_fix_suggestion_zh}"},{"subType":"welink","version":"v2","topic":"","content":"\nAlarm Name:${event_name_alias};\nAlarm ID:${id};\nOccurred:${starts_at};\nEvent Severity:${event_severity};\nAlarm Info:${alarm_info};\nResource Identifier:${resources_new};\nSuggestion:${alarm_fix_suggestion_zh};"}]",
		Name: "txytst2",
		Locale: "en-us",
		Desc: &descAddNotificationTemplate,
	}
	response, err := client.CreateNotificationTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

No Content 表示请求成功,但没有内容返回。

错误码

请参见错误码

相关文档