创建消息模板
功能介绍
该接口用于创建通知模板,目前每个账户最多可以创建共100个通知模板,创建后名称不可修改。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/{domain_id}/lts/events/notification/templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID |
domain_id |
是 |
String |
账号ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改 |
type |
否 |
Array of strings |
保留字段,非必填 |
desc |
否 |
String |
模板描述,非必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024 |
source |
是 |
String |
模板来源,目前必填为LTS,否则会筛选不出来 |
locale |
是 |
String |
语言,必填,目前可填zh-cn和en-us |
templates |
是 |
Array of SubTemplate objects |
模板正文,为一个数组 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sub_type |
是 |
String |
模板子类型,只支持以下5种类型:sms,dingding,wechat,webhook,email |
content |
是 |
String |
子模板正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。目前两种告警类型有共同变量如下: 告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 关键词告警特有变量: 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results; sql告警特有变量: 日志组/流名称:$event.annotations.results[0].resource_id; 查询语句:$event.annotations.results[0].sql; 查询时间:$event.annotations.results[0].time; 查询URL:$event.annotations.results[0].url;查询日志:$event.annotations.results[0].raw_results;
说明:
变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况 |
topic |
否 |
String |
邮件主题,只有sub_type=email时生效 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
通知规则名称,必填,只含有汉字、数字、字母、下划线、中划线,不能以下划线等特殊符号开头和结尾,长度为 1 - 100,创建后不可修改 |
type |
Array of strings |
保留字段,非必填 |
desc |
String |
模板描述,非必填,只含有汉字、数字、字母、下划线不能以下划线开头和结尾,长度为0--1024 |
source |
String |
模板来源,目前必填为LTS,否则会筛选不出来 |
locale |
String |
语言,必填,目前可填zh-cn和en-us |
templates |
Array of SubTemplateResBody objects |
模板正文,为一个数组 |
参数 |
参数类型 |
描述 |
---|---|---|
sub_type |
String |
模板子类型,只支持以下6种类型:sms,dingding,wechat,webhook,email 枚举值: |
content |
String |
子模板正文,$符号后所跟变量仅支持以下变量,根据不同告警类型(关键词告警和sql告警),所支持的变量亦不相同。目前两种告警类型有共同变量如下: 告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 关键词告警特有变量: 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results; sql告警特有变量: 日志组/流名称:$event.annotations.results[0].resource_id; 查询语句:$event.annotations.results[0].sql; 查询时间:$event.annotations.results[0].time; 查询URL:$event.annotations.results[0].url; 查询日志:$event.annotations.results[0].raw_results;
说明:
变量后面的分号";"为英文符号,必须添加,否则模板会出现替换失败的情况。 |
topic |
String |
邮件主题,只有sub_type=email时生效 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
请求示例
创建消息模板
POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/events/notification/templates { "name" : "xxx", "desc" : "xxxxxx", "type" : [ ], "source" : "LTS", "locale" : "zh-cn", "templates" : [ { "sub_type" : "sms", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "dingding", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "wechat", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "webhook", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;" }, { "sub_type" : "email", "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n告警源:$event.metadata.resource_provider;\n资源类型:$event.metadata.resource_type;\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;\n查询时间:$event.annotations.results[0].time;\n查询日志:$event.annotations.results[0].raw_results;" }, { "sub_type" : "voice", "content" : "告警级别:${event_severity}; \n发生时间:${starts_at}; \n资源标识:${resources}; \n统计类型:关键词统计; \n表达式:$event.annotations.condition_expression; \n当前值: $event.annotations.current_value; \n统计周期:$event.annotations.frequency;" } ] }
响应示例
状态码: 200
请求响应成功。
{ "desc" : "description", "locale" : "zh-cn", "name" : "postman-test", "source" : "LTS", "templates" : [ { "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;", "sub_type" : "sms" }, { "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;", "sub_type" : "dingding" }, { "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;", "sub_type" : "wechat" }, { "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;", "sub_type" : "webhook" }, { "content" : "告警级别:${event_severity};\n发生时间:${starts_at};\n告警源:$event.metadata.resource_provider;\n资源类型:$event.metadata.resource_type;\n资源标识:${resources};\n统计类型:关键词统计;\n表达式:$event.annotations.condition_expression;\n当前值: $event.annotations.current_value;\n统计周期:$event.annotations.frequency;\n查询时间:$event.annotations.results[0].time;\n查询日志:$event.annotations.results[0].raw_results;", "sub_type" : "email" }, { "content" : "告警级别:${event_severity}; \n发生时间:${starts_at}; \n资源标识:${resources}; \n统计类型:关键词统计; \n表达式:$event.annotations.condition_expression; \n当前值: $event.annotations.current_value; \n统计周期:$event.annotations.frequency;", "sub_type" : "voice" } ], "type" : [ ] }
状态码: 400
BadRequest 非法请求 建议根据error_msg直接修改该请求。
{ "error_code" : "LTS.2014", "error_msg" : "desc is invalid!" }
状态码: 500
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.2014", "error_msg" : "Failed to create notification template." }
SDK代码示例
SDK代码示例如下。
创建消息模板
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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
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.lts.v2.region.LtsRegion; import com.huaweicloud.sdk.lts.v2.*; import com.huaweicloud.sdk.lts.v2.model.*; import java.util.List; import java.util.ArrayList; 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("<YOUR REGION>")) .build(); CreateNotificationTemplateRequest request = new CreateNotificationTemplateRequest(); request.withDomainId("{domain_id}"); CreateNotificationTemplateRequestBody body = new CreateNotificationTemplateRequestBody(); List<SubTemplate> listbodyTemplates = new ArrayList<>(); listbodyTemplates.add( new SubTemplate() .withSubType(SubTemplate.SubTypeEnum.fromValue("sms")) .withContent("告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;") ); listbodyTemplates.add( new SubTemplate() .withSubType(SubTemplate.SubTypeEnum.fromValue("dingding")) .withContent("告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;") ); listbodyTemplates.add( new SubTemplate() .withSubType(SubTemplate.SubTypeEnum.fromValue("wechat")) .withContent("告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;") ); listbodyTemplates.add( new SubTemplate() .withSubType(SubTemplate.SubTypeEnum.fromValue("webhook")) .withContent("告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;") ); listbodyTemplates.add( new SubTemplate() .withSubType(SubTemplate.SubTypeEnum.fromValue("email")) .withContent("告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results;") ); listbodyTemplates.add( new SubTemplate() .withSubType(SubTemplate.SubTypeEnum.fromValue("voice")) .withContent("告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;") ); body.withTemplates(listbodyTemplates); body.withLocale(CreateNotificationTemplateRequestBody.LocaleEnum.fromValue("zh-cn")); body.withSource("LTS"); body.withDesc("xxxxxx"); body.withName("xxx"); 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()); } } } |
创建消息模板
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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklts.v2.region.lts_region import LtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklts.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"] credentials = BasicCredentials(ak, sk) client = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateNotificationTemplateRequest() request.domain_id = "{domain_id}" listTemplatesbody = [ SubTemplate( sub_type="sms", content="告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;" ), SubTemplate( sub_type="dingding", content="告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;" ), SubTemplate( sub_type="wechat", content="告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;" ), SubTemplate( sub_type="webhook", content="告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;" ), SubTemplate( sub_type="email", content="告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results;" ), SubTemplate( sub_type="voice", content="告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;" ) ] request.body = CreateNotificationTemplateRequestBody( templates=listTemplatesbody, locale="zh-cn", source="LTS", desc="xxxxxx", name="xxx" ) 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) |
创建消息模板
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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := lts.NewLtsClient( lts.LtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateNotificationTemplateRequest{} request.DomainId = "{domain_id}" var listTemplatesbody = []model.SubTemplate{ { SubType: model.GetSubTemplateSubTypeEnum().SMS, Content: "告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;", }, { SubType: model.GetSubTemplateSubTypeEnum().DINGDING, Content: "告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;", }, { SubType: model.GetSubTemplateSubTypeEnum().WECHAT, Content: "告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;", }, { SubType: model.GetSubTemplateSubTypeEnum().WEBHOOK, Content: "告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;", }, { SubType: model.GetSubTemplateSubTypeEnum().EMAIL, Content: "告警级别:${event_severity}; 发生时间:${starts_at}; 告警源:$event.metadata.resource_provider; 资源类型:$event.metadata.resource_type; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency; 查询时间:$event.annotations.results[0].time; 查询日志:$event.annotations.results[0].raw_results;", }, { SubType: model.GetSubTemplateSubTypeEnum().VOICE, Content: "告警级别:${event_severity}; 发生时间:${starts_at}; 资源标识:${resources}; 统计类型:关键词统计; 表达式:$event.annotations.condition_expression; 当前值: $event.annotations.current_value; 统计周期:$event.annotations.frequency;", }, } request.Body = &model.CreateNotificationTemplateRequestBody{ Templates: listTemplatesbody, Locale: model.GetCreateNotificationTemplateRequestBodyLocaleEnum().ZH_CN, Source: "LTS", Desc: "xxxxxx", Name: "xxx", } response, err := client.CreateNotificationTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功。 |
400 |
BadRequest 非法请求 建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。