创建告警通知 - CreateAlertNoticeConfig

project_id

是

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

租户token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

是

String

参数解释：

内容类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json;charset=utf8

enterpriseProjectId

是

String

参数解释：

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。

约束限制：

不涉及

取值范围：

• 0：代表default企业项目

• all_granted_eps：代表所有企业项目

• 其它企业项目ID：长度为36个字符

默认取值：

0

X-Language

是

String

参数解释：

语言，默认值为en-us。zh-cn（中文）/en-us（英文）

约束限制：

不涉及

取值范围：

不涉及

默认取值：

zh-cn

enabled

是

Boolean

参数解释：

功能启用状态：true表示启用当前配置，false表示禁用。

约束限制：

不涉及

取值范围：

• true

• false

默认取值：

true

prefer_html

是

Boolean

参数解释：

预留参数，默认为false

约束限制：

不涉及

取值范围：

不涉及

默认取值：

false

topic_urn

是

String

参数解释：

通知模板，关联用于发送告警通知的SMN主题URN,通过“消息通知服务”获取

查询可使用的主题，通过 云日志服务的“查询SMN主题”接口，返回体中的"topic_urn"字段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sendfreq

否

Integer

参数解释：

通间间隔,单位为分钟。当通知类型为防护事件时,该参数表示在该时间间隔内,攻击次数等于或者大于设定阈值时,将发送告警通知,支持的值:5、15、30、60、120、360、720、1440;当通知类型为证书到期时,该参数表示每隔多长时间发送一次告警通知,支持的值为1440、10080(单位为分钟)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

local

是

String

参数解释：

地区，指定告警通知的语言或地域相关配置

约束限制：

不涉及

取值范围：

• zh-cn

• en-us

默认取值：

不涉及

times

否

Integer

参数解释：

当通知类型为防护事件时,需要填写该参数。在该时间间隔内,当攻击次数大于或等于您设置的阈值时才会发送告警通知

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

是

String

参数解释：

告警名称，用于标识告警通知配置的名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

notice_class

是

String

参数解释：

告警类型，区分不同场景的告警（如防护规则触发、资源异常等）

约束限制：

不涉及

取值范围：

• threat_alert_notice：威胁告警通知

• cert_alert_notice：证书告警通知,

• rule_alert_notice：规则告警通知,

• cname_ip_alert_notice：域名 / IP 告警通知

默认取值：

不涉及

nearly_expired_time

否

Long

参数解释：

提前通知天数，针对过期类告警提前发送通知的天数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

is_all_enterprise_project

是

Boolean

参数解释：

是否所有企业项目，标识该告警配置是否适用于所有企业项目

约束限制：

不涉及

取值范围：

• true

• false

默认取值：

true

description

否

String

参数解释：

描述，对告警通知配置的补充说明

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

threat

否

Array of strings

参数解释：

威胁类型范围：指定需要告警的威胁类型，如["all"]表示所有威胁

约束限制：

不涉及

取值范围：

不涉及

默认取值：

all

rule_type

否

Array of strings

参数解释：

指定需要告警的规则类型，["all"]表示所有规则类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

all

id

String

ID

name

String

告警通知名称

enabled

Boolean

是否开启

• false: 不开启

• true: 开启

topic_urn

String

主题

sendfreq

Integer

时间间隔，单位为分钟。当通知类型为防护事件时，该参数表示在该时间间隔内，攻击次数等于或者大于设定阈值时，将发送告警通知，支持的值：5、15、30、60、120、360、720、1440；当通知类型为证书到期时，该参数表示每隔多长时间发送一次告警通知，支持的值1天、1周（需要转换成分钟）。

locale

String

语言

times

Integer

当通知类型为防护事件时，需要填写该参数。在该时间间隔内，当攻击次数大于或等于您设置的阈值时才会发送告警通知

threat

Array of strings

事件类型

prefer_html

Boolean

预留参数，可忽略

notice_class

String

通知类型

nearly_expired_time

String

提前通知天数

is_all_enterprise_project

Boolean

是否是所有企业项目

enterprise_project_id

String

企业项目ID

update_time

Long

更新时间

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

200

参数解释：

请求成功

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

400

参数解释：

请求失败

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

401

参数解释：

token权限不足

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

500

参数解释：

服务器内部错误

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及