GetAlarm-查询 DDoS 基础防护攻击事件--DDoS防护-火山引擎

文档中心

立即注册

导航

GetAlarm-查询 DDoS 基础防护攻击事件

最近更新时间：2025.05.28 19:19:48首次发布时间：2024.01.26 20:49:21

调用 GetAlarm 接口查询指定 IP 的 DDoS 基础防护攻击事件信息，包括攻击类型、攻击峰值、攻击状态、黑洞封禁状态等信息。

注意事项

查询时设置的起始时间和结束时间，仅用于限定攻击事件的发生时间，但不代表攻击必须在此时间范围内结束。
例如设置起始时间为 2025-03-01 00:00:00，结束时间为2025-04-30 23:59:59。某个攻击事件开始时间为2025-04-30 23:58:00，当前攻击状态为攻击中，则该攻击事件会展示在查询列表中。因为攻击的开始时间落在了指定的查询时间区间内，即使攻击尚未结束。
调用时请将{region}替换成实际地域 ID，地域详情参见地域信息。

场景说明

查询攻击事件

查询在指定时间段内开始的全部攻击事件，需要：

设置指定的起始时间beginDate和结束时间endDate。
黑洞封禁状态blockStatus可以不传，保持默认值0。

查询黑洞封禁 IP

查询当前时刻处于黑洞封禁中的 IP 资产，需要：

设置黑洞封禁状态blockStatus为1。
查询时间可以不传，默认为 180 天前至今。

请求说明

请求方式：POST
请求地址：https://ddos.{region}.volcengineapi.com/?Action=GetAlarm&Version=2020-12-08

请求参数

以下为该接口的 Query 参数和 Body 参数，其他公共参数请参见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	`GetAlarm`	接口名称。与实际业务的接口名称一致。
Version	String	是	`2020-12-08`	接口的版本。DDoS 基础防护提供的 OpenAPI 版本为`2020-12-08`。

Body

参数	类型	是否必填	示例值	描述
ip	String	否	`192.1.1.1`	待查询的 IP。如果 IP 为空或不合法，则返回账户下所有 IP 资产的 DDoS 基础防护攻击事件信息。
page	Integer	否	`1`	当前页面的页码。例如，`1`表示展示查询到的第 1 页事件信息。默认为`1`。
pageSize	Integer	否	`20`	单个页面显示的事件数量，最大值为 50。不填写或为负值时，显示为 20。
beginDate	String	否	`2024-10-01 00:00:00`	起始时间，查询攻击开始于该时间之后的事件。最早支持查询 180 天前的数据。不填写则默认为 180 天前。
endDate	String	否	`2024-12-31 11:59:59`	结束时间，查询攻击开始于该时间之前的事件，与攻击事件是否结束无关。不填写则默认为当前时间。
blockStatus	Integer	否	`1`	黑洞封禁状态，可用于快速筛选当前处于黑洞封禁中或当前黑洞封禁已经结束的资产 IP。默认查询全部状态下的 IP。 0：全部 1：黑洞封禁中 2：黑洞封禁结束该筛选值仅代表当前时刻的黑洞状态，与查询时间区间无关。例如设置 blockStatus 为 1（黑洞封禁中）：当 IP 遭受攻击的时间在查询区间内，但黑洞封禁发生在查询结束时间之后，只要该 IP 当前仍处于封禁状态，这条记录就会出现在查询结果中。相反，如果 IP 在查询时间区间内曾被黑洞封禁，但在执行查询时已解除封禁，则该记录将不会显示在查询结果中。

返回参数

参数	类型	示例值	描述
PageInfo	PageInfo object	-	页面信息。
Result	Array of Result objects	-	查询到的攻击事件信息。

PageInfo

参数	类型	示例值	描述
TotalCount	Integer	`3`	查询到的符合条件的攻击事件总数。
PageSize	Integer	`10`	单个页面显示的事件数量。
CurrentPage	Integer	`1`	当前页面的页码。例如，`1` 表示展示查询到的第 1 页事件信息。
Count	Integer	`3`	当前页面中包含的事件数量。

Result

参数	类型	示例值	描述
Id	Integer	`5267`	攻击事件的 ID。
Ip	String	`192.1.1.1`	被攻击的 IP。
AttackType	String	`UDP Flood`	攻击事件类型。 UDP Reflect Flood SYN- ACK Flood FIN/RST Flood Malformed Flood DNS Flood ACK Flood Other Flood ICMP Flood SYN Flood UDP Flood Other Protocol Flood
PpsPeak	Integer	`4532`	攻击包速率峰值，单位为 pps。
BpsPeak	Integer	`2406000`	攻击带宽峰值，单位为 bps。
StartTime	String	`2024-10-18 20:03:40`	攻击开始时间。
EndTime	String	`2024-10-18 21:03:49`	攻击结束时间。
PeakTime	String	`2024-10-18 20:17:13`	攻击带宽达到峰值的时间。
Product	String	`EcsInstance`	IP 绑定的资产类型，为空则表示未绑定资源。 EcsInstance：云服务器 ClbInstance：负载均衡 AlbInstance：应用型负载均衡 NetworkInterface：网卡 Nat：NAT 网关
BlockStatus	Integer	`0`	黑洞封禁状态。 0：未触发黑洞 1：黑洞封禁中 2：黑洞封禁结束
BlockStartTime	String	`2024-10-18 20:03:40`	黑洞封禁开始时间。
BlockEndTime	String	`2024-10-18 21:03:49`	黑洞解封时间。

请求示例

POST https://ddos.{region}.volcengineapi.com/?Action=GetAlarm&Version=2020-12-08

{
  "ip": "192.1.1.1",
  "beginDate": "2024-10-01 00:00:00",
  "endDate": "2024-12-31 11:59:59",
  "blockStatus": 1,
  "page": 1,
  "pageSize": 10
}

返回示例

{
    "PageInfo": {
        "TotalCount": 2,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 2
    },
    "ResponseMetadata": {
        "RequestID": "20240124220259B57348F295C8E01D****",
        "Action": "GetAlarm",
        "Version": "2020-12-08",
        "Service": "ddos",
        "Region": "cn-beijing"
    },
    "Result": [
        {
            "Id": 7566,
            "Ip": "192.1.1.1",
            "AttackType": "UDP Flood",
            "PpsPeak": 4532,
            "BpsPeak": 52099000,
            "StartTime": "2024-12-28 06:17:10",
            "EndTime": "2024-12-28 06:18:40",
            "PeakTime": "2024-12-28 06:17:13",
            "Product": "EcsInstance",
            "BlockStatus": 0,
            "BlockStartTime": "",
            "BlockEndTime": ""
        },
        {
            "Id": 5268,
            "Ip": " 192.1.1.1",
            "AttackType": "Other Flood",
            "PpsPeak": 0,
            "BpsPeak": 0,
            "StartTime": "2024-10-18 20:03:40",
            "EndTime": "2024-10-18 21:03:49",
            "PeakTime": "2024-10-18 20:03:40",
            "Product": "EcsInstance",
            "BlockStatus": 2,
            "BlockStartTime": "2024-10-18 20:03:40",
            "BlockEndTime": "2024-10-18 21:03:49"
        }
    ]
}