QueryUserAlarmConfig - 查询告警通知--云防火墙-火山引擎

文档中心

立即注册

云防火墙

告警通知

QueryUserAlarmConfig - 查询告警通知

查询已配置的告警通知详情，包括互联网防火墙、VPC 防火墙、NAT 防火墙以及日志管理的告警通知。

请求说明

请求方式：POST
请求地址：https://fw-center.volcengineapi.com/?Action=QueryUserAlarmConfig&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`QueryUserAlarmConfig`	接口名称。当前 API 的名称为 `QueryUserAlarmConfig`。
Version	String	是	`2021-09-06`	接口版本。当前 API 的版本为 `2021-09-06`。

Body

参数	类型	是否必选	示例值	描述
CloudFirewallId	String	否	`CloudFirewall********`	云防火墙实例 ID

返回参数

参数	类型	示例值	描述
UserAlarmConfigList	Array of QueryUserAlarmConfigStructure	`--`	用户告警通知配置详情。

QueryUserAlarmConfigStructure

参数	类型	示例值	描述
Enable	Integer	`1`	告警开关： -1：关 1：开
AlarmType	String	`LogCap`	告警类型： LogCap：日志容量通知 CloudBandWidth：互联网防火墙流量带宽通知 CloudPolicy：互联网防火墙策略通知 CloudAsset：公网 IP 资产用量通知 CloudNewAsset：新增未防护公网资产通知 CloudAutoAsset：自动防护资产首次拦截通知 CloudSecurityAlarm：互联网防火墙安全告警通知 VpcBandWidth：VPC 防火墙流量带宽通知 VpcPolicy：VPC 防火墙策略通知 VpcNewRelease：VPC 防火墙新版本通知 VpcUpgradeSuccess：VPC 防火墙升级成功通知 VpcUpgradeFailed：VPC 防火墙升级失败通知 VpcSecurityAlarm：VPC 防火墙安全告警通知 NatBandWidth：NAT 防火墙流量带宽通知 NatPolicy：NAT 防火墙策略通知 NatSecurityAlarm：NAT 防火墙安全告警通知
AlarmLevel	Array of String	`["Low"]`	告警级别： Low：低危 Medium：中危 High：高危 Critical：致命
AlarmAction	Array of String	`["Deny"]`	告警动作： Deny：拦截 Monitor：观察
AlarmMethod	Array of String	`["Phone"]`	告警方式： Phone：电话告警
AlarmEndTime	Integer	`0`	告警通知结束时间，单位：秒
AlarmInterval	Integer	`1`	告警通知频率，单位：天
AlarmStartTime	Integer	`0`	告警通知开始时间，单位：秒
AlarmThreshold	Integer	`50`	告警阈值，单位：%
AlarmTimeRange	Integer	`1`	告警通知的时间设置，取值： 1：白天，即 08:00~20:00。返回该值时，`AlarmStartTime` 和 `AlarmEndTime` 参数不生效。 2：全天，即 00:00~24:00。返回该值时，`AlarmStartTime` 和 `AlarmEndTime` 参数不生效。 -1：自定义时间，返回该值时，自定义时间由 `AlarmStartTime` 和 `AlarmEndTime` 参数确定。

请求示例

POST https://fw-center.volcengineapi.com/?Action=QueryUserAlarmConfig&Version=2021-09-06
{
    "CloudFirewallId": "CloudFirewall********"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "QueryUserAlarmConfig",
        "Region": "cn-beijing",
        "Service": "fw_center",
        "Version": "2021-09-06",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "UserAlarmConfigList": [
            {
                "Enable": "1",
                "AlarmType": "LogCap",
                "AlarmLevel": [
                    "Low"
                ],
                "AlarmAction": [
                    "Deny"
                ],
                "AlarmMethod": [
                    "Phone"
                ],
                "AlarmEndTime": 0,
                "AlarmInterval": 1,
                "AlarmStartTime": 0,
                "AlarmThreshold": 50,
                "AlarmTimeRange": 1
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.12.31 15:16:09

这个页面对您有帮助吗？

有用

无用