Modifying a Message Template
Function
This API is used to modify a message template.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
aom:notificationTemplate:update
Write
-
-
-
-
URI
PUT /v2/{project_id}/events/notification/templates
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. For details, see Obtaining a Token. |
|
Content-Type |
Yes |
String |
Message body type or format. Content type, which is application/json. |
|
Enterprise-Project-Id |
No |
String |
Enterprise project ID. For details, see Obtaining an Enterprise Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
desc |
No |
String |
Message template description. |
||||||||||||||||||||||||
|
locale |
Yes |
String |
Message template language. |
||||||||||||||||||||||||
|
name |
Yes |
String |
Message template name, which cannot be modified. |
||||||||||||||||||||||||
|
templates |
Yes |
String |
Message template content. The content is escaped from JSON arrays consisting of the following parameters:
|
Response Parameters
Status code: 204
No Content: The request is successful, but no content is returned.
None
Example Requests
Modify the message template named test2.
/v2/{project_id}/events/notification/templates
{
"desc" : "",
"name" : "test2",
"locale" : "en-us",
"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};\"}]"
}
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Java
Modify the message template named 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 UpdateNotificationTemplateSolution { 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(); UpdateNotificationTemplateRequest request = new UpdateNotificationTemplateRequest(); UpdateNotificationTemplate body = new UpdateNotificationTemplate(); 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("test2"); body.withLocale("en-us"); body.withDesc(""); request.withBody(body); try { UpdateNotificationTemplateResponse response = client.updateNotificationTemplate(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()); } } } |
Python
Modify the message template named 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 = UpdateNotificationTemplateRequest() request.body = UpdateNotificationTemplate( 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="test2", locale="en-us", desc="" ) response = client.update_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) |
Go
Modify the message template named 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.UpdateNotificationTemplateRequest{} descUpdateNotificationTemplate:= "" request.Body = &model.UpdateNotificationTemplate{ 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: "test2", Locale: "en-us", Desc: &descUpdateNotificationTemplate, } response, err := client.UpdateNotificationTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
No Content: The request is successful, but no content is returned. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot