更新事件类告警规则
功能介绍
更新事件类告警规则。
调用方法
请参见如何调用API。
URI
PUT /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 |
是 |
Integer |
创建时间 最小值：0 最大值：9999999999999 |
|
update_time |
否 |
Integer |
更新时间 最小值：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为"xxxxxxx"、事件来源为"AOM"且名称为"scl_test_event"的事件类告警规则
https://{endpoint}/v2/{project_id}/event2alarm-rule
{
"user_id" : "xxxxxxx",
"name" : "scl_test_event",
"description" : "",
"create_time" : 1669276304343,
"update_time" : 1669276304343,
"resource_provider" : "AOM",
"metadata" : {
"customField" : [ "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"
}
状态码： 500
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。
{
"error_code" : "APM.00000500",
"error_msg" : "Internal Server Error",
"trace_id" : ""
}
状态码
|
状态码 |
描述 |
|---|---|
|
204 |
OK 请求响应成功。 |
|
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
|
401 |
Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
403 |
Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
|
500 |
InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
错误码
请参见错误码。
