新增一条事件类告警规则
功能介绍
新增一条事件类告警规则。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/event2alarm-rule
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度:0 最大长度:40960 |
Content-Type |
是 |
String |
指定类型为application/json。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
user_id |
是 |
String |
用户项目id 最小长度:32 最大长度:32 |
name |
是 |
String |
规则名称。规则名称包含大小写字母,数字,特殊字符(_-)和汉字组成,不能以特殊字符开头或结尾,最大长度为100。 最小长度:1 最大长度:100 |
description |
否 |
String |
规则描述。描述包含大小写字母,数字,特殊字符(_-<>=,.)和汉字组成,不能以下划线、中划线开头结尾,最大长度为1024。 最小长度:0 最大长度:1024 |
create_time |
是 |
Long |
创建时间 最小值:0 最大值:9999999999999 |
update_time |
否 |
Long |
更新时间 最小值:0 最大值:9999999999999 |
resource_provider |
否 |
String |
事件源 最小长度:0 最大长度:64 |
metadata |
是 |
metadata object |
源数据 |
enable |
是 |
Boolean |
规则是否启用 |
trigger_policies |
是 |
Array of trigger_policies objects |
触发策略 数组长度:0 - 1024 |
alarm_type |
是 |
String |
告警类型。notification:直接告警。denoising:告警降噪。 最小长度:0 最大长度:32 枚举值:
|
action_rule |
是 |
String |
告警行动规则 最小长度:0 最大长度:128 |
inhibit_rule |
否 |
String |
告警抑制规则 最小长度:0 最大长度:128 |
route_group_rule |
否 |
String |
告警分组规则 最小长度:0 最大长度:128 |
event_names |
否 |
Array of strings |
事件名称 |
migrated |
否 |
Boolean |
是否迁移到2.0 |
topics |
否 |
Array of SmnTopics objects |
smn信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
Integer |
自增编号 最小值:0 最大值:128 |
name |
否 |
String |
事件名称 最小长度:0 最大长度:128 |
trigger_type |
否 |
String |
触发类型。accumulative: 累计触发,immediately: 立即触发 最小长度:0 最大长度:128 枚举值:
|
period |
否 |
Integer |
触发周期 最小值:1 最大值:86400 |
operator |
否 |
String |
比较符 最小长度:0 最大长度:8 |
count |
否 |
Integer |
触发次数 最小值:1 最大值:100 |
level |
否 |
String |
告警等级 最小长度:0 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
display_name |
否 |
String |
Topic的显示名,推送邮件消息时,作为邮件发件人显示。显示名的长度为192byte或64个中文。默认值为空。 最小长度:1 最大长度:64 |
name |
是 |
String |
创建topic的名字。Topic名称只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度为1到255个字符。 最小长度:1 最大长度:255 |
push_policy |
是 |
Integer |
SMN消息推送策略。取值为0或1 最小值:0 最大值:1 |
status |
否 |
Integer |
topic中订阅者的状态。0:主题已删除或主题下订阅列表为空。1:主题下的订阅列表存在状态为“已订阅”的订阅信息。2:主题下的订阅信息状态处于“未订阅”或“已取消”。 枚举值:
|
topic_urn |
是 |
String |
Topic的唯一的资源标识。 最小长度:1 最大长度:100 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
请求示例
新增一条用户id为"xxxx",名称为"scl_test_event",事件来源为"AOM"的事件类告警规则。
https://{endpoint}/v2/{project_id}/event2alarm-rule { "user_id" : "xxxx", "name" : "scl_test_event", "description" : "", "create_time" : 1669276173427, "update_time" : 0, "resource_provider" : "AOM", "metadata" : { "customField" : [ "xxx=xxx" ] }, "enable" : true, "trigger_policies" : [ { "id" : 0, "name" : "", "trigger_type" : "accumulative", "period" : 300, "operator" : ">=", "count" : 99, "level" : "" } ], "alarm_type" : "notification", "action_rule" : "111111", "inhibit_rule" : "", "route_group_rule" : "" }
响应示例
状态码: 204
OK 请求响应成功。
状态码: 400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.02011400", "error_msg" : "actionRule is invalid!", "error_type" : "BAD_REQUEST", "trace_id" : "" }
状态码: 401
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
{ "error_code" : "SVCSTG.AMS.2000051", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED" }
状态码: 403
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "error_code" : "SVCSTG.AMS.2000051", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : "8fb508e9e31b44279016f708e1c60e4c" }
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" }
SDK代码示例
SDK代码示例如下。
新增一条用户id为"xxxx",名称为"scl_test_event",事件来源为"AOM"的事件类告警规则。
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 |
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.*; import java.util.List; import java.util.ArrayList; public class AddEvent2alarmRuleSolution { 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); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); AddEvent2alarmRuleRequest request = new AddEvent2alarmRuleRequest(); Event2alarmRuleBody body = new Event2alarmRuleBody(); List<Event2alarmRuleBodyTriggerPolicies> listbodyTriggerPolicies = new ArrayList<>(); listbodyTriggerPolicies.add( new Event2alarmRuleBodyTriggerPolicies() .withId(0) .withName("") .withTriggerType(Event2alarmRuleBodyTriggerPolicies.TriggerTypeEnum.fromValue("accumulative")) .withPeriod(300) .withOperator(">=") .withCount(99) .withLevel("") ); List<String> listMetadataCustomField = new ArrayList<>(); listMetadataCustomField.add("xxx=xxx"); Event2alarmRuleBodyMetadata metadatabody = new Event2alarmRuleBodyMetadata(); metadatabody.withCustomField(listMetadataCustomField); body.withRouteGroupRule(""); body.withInhibitRule(""); body.withActionRule("111111"); body.withAlarmType(Event2alarmRuleBody.AlarmTypeEnum.fromValue("notification")); body.withTriggerPolicies(listbodyTriggerPolicies); body.withEnable(true); body.withMetadata(metadatabody); body.withResourceProvider("AOM"); body.withUpdateTime(0L); body.withCreateTime(1669276173427L); body.withDescription(""); body.withName("scl_test_event"); body.withUserId("xxxx"); request.withBody(body); try { AddEvent2alarmRuleResponse response = client.addEvent2alarmRule(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()); } } } |
新增一条用户id为"xxxx",名称为"scl_test_event",事件来源为"AOM"的事件类告警规则。
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = AddEvent2alarmRuleRequest() listTriggerPoliciesbody = [ Event2alarmRuleBodyTriggerPolicies( id=0, name="", trigger_type="accumulative", period=300, operator=">=", count=99, level="" ) ] listCustomFieldMetadata = [ "xxx=xxx" ] metadatabody = Event2alarmRuleBodyMetadata( custom_field=listCustomFieldMetadata ) request.body = Event2alarmRuleBody( route_group_rule="", inhibit_rule="", action_rule="111111", alarm_type="notification", trigger_policies=listTriggerPoliciesbody, enable=True, metadata=metadatabody, resource_provider="AOM", update_time=0, create_time=1669276173427, description="", name="scl_test_event", user_id="xxxx" ) response = client.add_event2alarm_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
新增一条用户id为"xxxx",名称为"scl_test_event",事件来源为"AOM"的事件类告警规则。
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AddEvent2alarmRuleRequest{} idTriggerPolicies:= int32(0) nameTriggerPolicies:= "" triggerTypeTriggerPolicies:= model.GetEvent2alarmRuleBodyTriggerPoliciesTriggerTypeEnum().ACCUMULATIVE periodTriggerPolicies:= int32(300) operatorTriggerPolicies:= ">=" countTriggerPolicies:= int32(99) levelTriggerPolicies:= "" var listTriggerPoliciesbody = []model.Event2alarmRuleBodyTriggerPolicies{ { Id: &idTriggerPolicies, Name: &nameTriggerPolicies, TriggerType: &triggerTypeTriggerPolicies, Period: &periodTriggerPolicies, Operator: &operatorTriggerPolicies, Count: &countTriggerPolicies, Level: &levelTriggerPolicies, }, } var listCustomFieldMetadata = []string{ "xxx=xxx", } metadatabody := &model.Event2alarmRuleBodyMetadata{ CustomField: &listCustomFieldMetadata, } routeGroupRuleEvent2alarmRuleBody:= "" inhibitRuleEvent2alarmRuleBody:= "" resourceProviderEvent2alarmRuleBody:= "AOM" updateTimeEvent2alarmRuleBody:= int64(0) descriptionEvent2alarmRuleBody:= "" request.Body = &model.Event2alarmRuleBody{ RouteGroupRule: &routeGroupRuleEvent2alarmRuleBody, InhibitRule: &inhibitRuleEvent2alarmRuleBody, ActionRule: "111111", AlarmType: model.GetEvent2alarmRuleBodyAlarmTypeEnum().NOTIFICATION, TriggerPolicies: listTriggerPoliciesbody, Enable: true, Metadata: metadatabody, ResourceProvider: &resourceProviderEvent2alarmRuleBody, UpdateTime: &updateTimeEvent2alarmRuleBody, CreateTime: int64(1669276173427), Description: &descriptionEvent2alarmRuleBody, Name: "scl_test_event", UserId: "xxxx", } response, err := client.AddEvent2alarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
204 |
OK 请求响应成功。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。