参数解释:
功能介绍
参数解释:
创建告警通知
约束限制:
不涉及
取值范围:
不涉及
默认取值:
不涉及
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/waf/alert
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 用户项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 租户token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
enterpriseProjectId |
是 |
String |
参数解释: 企业项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Language |
是 |
String |
参数解释: 语言,默认值为en-us。zh-cn(中文)/en-us(英文) 约束限制: 不涉及 取值范围: 不涉及 默认取值: zh-cn |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
参数解释: 告警id,用于唯一标识一条告警通知配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
enabled |
否 |
Boolean |
参数解释: 是否开启告警,控制该告警通知配置的启用/禁用状态 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
topic_urn |
否 |
String |
参数解释: 通知模板,关联用于发送告警通知的SMN主题URN 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sendfreq |
否 |
Integer |
参数解释: 通知频率,控制告警通知的发送间隔 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
locale |
否 |
String |
参数解释: 地区,指定告警通知的语言或地域相关配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
times |
否 |
Integer |
参数解释: 通知频率(补充说明,与sendfreq协同控制告警发送频次) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
否 |
String |
参数解释: 告警名称,用于标识告警通知配置的名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
notice_class |
否 |
String |
参数解释: 告警类型,区分不同场景的告警(如防护规则触发、资源异常等) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nearly_expired_time |
否 |
Long |
参数解释: 提前通知天数,针对过期类告警提前发送通知的天数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
is_all_enterprise_project |
否 |
Boolean |
参数解释: 是否所有企业项目,标识该告警配置是否适用于所有企业项目 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
description |
否 |
String |
参数解释: 描述,对告警通知配置的补充说明 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 告警通知ID 取值范围: 不涉及 |
name |
String |
参数解释: 告警通知名称 取值范围: 只能由中文、字母、数字、下划线、连字符、冒号和英文句号组成,且不能超过64个字符长度。 |
enabled |
Boolean |
参数解释: 是否开启 取值范围:
|
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 |
参数解释: 更新时间 取值范围: 13位毫秒时间戳 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
参数解释: 请求成功 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
400 |
参数解释: 请求失败 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
401 |
参数解释: token权限不足 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
500 |
参数解释: 服务器内部错误 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
错误码
请参见错误码。