修改告警配置接口
功能介绍
修改告警配置接口
调用方法
请参见如何调用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,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,可通过如何获取用户Token获取 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
account_name |
否 |
String |
账号名称 |
alarm_id |
否 |
String |
告警id |
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 |
告警语言 |
severity |
否 |
String |
告警等级 |
topic_urn |
否 |
String |
告警urn |
username |
否 |
String |
用户名称 |
请求示例
配置项目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" }
响应示例
状态码: 200
OK
{ "data" : { "id" : "8de37729-026d-412f-ba82-80c46f388d14" } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。