文档首页/ 云防火墙 CFW/ API参考/ API/ 告警配置管理/ 获取告警配置信息
更新时间：2024-12-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取告警配置信息

功能介绍

获取告警配置信息

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/cfw/alarm/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从调API处获取，也可以从控制台获取。可通过项目ID获取方式获取
表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

防火墙ID，可通过防火墙ID获取方式获取

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，可通过如何获取用户Token获取

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

alarm_configs

Array of AlarmConfig objects

告警配置列表

data

Object
表5 AlarmConfig

参数

参数类型

描述

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

告警语言

name

String

告警主题名称

severity

String

告警等级

topic_urn

String

告警urn

username

String

用户名称

请求示例

查询项目id为408972e72dcd4c1a9b033e955802a36b的防火墙告警配置，防火墙id为8de37729-026d-412f-ba82-80c46f388d14。

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/alarm/config?fw_instance_id=8de37729-026d-412f-ba82-80c46f388d14

响应示例

状态码： 200

OK

{
  "alarm_configs" : [ {
    "alarm_time_period" : 0,
    "alarm_type" : 1,
    "enable_status" : 0,
    "severity" : "1"
  }, {
    "alarm_time_period" : 0,
    "alarm_type" : 2,
    "enable_status" : 0,
    "severity" : "3"
  } ]
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 告警配置管理

相关文档