修改告警配置接口
功能介绍
修改告警配置接口
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/cfw/alarm/config
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| fw_instance_id | 是 | String | 防火墙ID,可通过防火墙ID获取方式获取 |
| enterprise_project_id | 否 | String | 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,用户未开启企业项目时为0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token,可通过如何获取用户Token获取 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| alarm_time_period | 是 | Integer | 告警周期,0:全天,1:8时到22时 |
| alarm_type | 是 | Integer | 告警类型 0:攻击告警; 1:流量超额预警; 2:EIP未防护告警; 3:异常外联告警 |
| enable_status | 是 | Integer | 告警状态 0:失效; 1:生效 |
| frequency_count | 是 | Integer | 告警触发频次 |
| frequency_time | 是 | Integer | 告警频次时间范围,以分钟为单位 |
| language | 否 | String | 告警语言,zh-cn为中文,en-us为英文 |
| severity | 是 | String | 告警等级,当type为0和4时,severity为CRITICAL,HIGH,MEDIUM,LOW四种等级的组合字符串,当type为1时,severity为2;当type为2时,severity固定为3 |
| topic_urn | 是 | String | 告警urn |
| username | 是 | String | 用户名称,为cfw |
请求示例
配置项目id为408972e72dcd4c1a9b033e955802a36b的防火墙告警,防火墙ID为8de37729-026d-412f-ba82-80c46f388d14。告警类型为1,告警时间周期为0,启用状态为0,严重程度为0。告警策略为防护带宽使用率达到80%时,每天告警一次。告警名称为test-wyl,主题URN为urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl。
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/alarm/config?fw_instance_id=8de37729-026d-412f-ba82-80c46f388d14
{
"alarm_time_period" : 0,
"alarm_type" : 1,
"enable_status" : 0,
"severity" : "0",
"frequency_count" : 1,
"frequency_time" : 1,
"topic_urn" : "urn:smn:cn-north-7:408972e72dcd4c1a9b033e955802a36b:test-wyl",
"username" : "cfw"
} 响应示例
状态码:200
OK
{
"data" : {
"id" : "8de37729-026d-412f-ba82-80c46f388d14"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 401 | Unauthorized,错误的请求 |
| 403 | Forbidden,禁止访问 |
| 404 | Not Found,网页未找到 |
错误码
请参见错误码。