You need to enable JavaScript to run this app.
导航
DDoS防护
  • 文档首页
    • /
  • DDoS防护

GetAlarm-获取基础防护攻击和黑洞信息

最近更新时间：2024.03.11 11:43:41

首次发布时间：2024.01.26 20:49:21

我的收藏

查询指定 IP 的 DDoS 基础防护攻击和黑洞信息。

请求说明

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

请求参数

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

Query

参数

类型

是否必填

示例值

描述

Action

String

是

GetAlarm

接口名称。与实际业务的接口名称一致。

Version

String

是

2022-01-01

接口的版本。DDoS 基础防护提供的 OpenAPI 版本为2022-01-01。

Body

参数

类型

是否必填

示例值

描述

Ip

String

否

1.1.1.1

  • 待查询资产的 IP。
  • 如果 IP 为空或不合法，返回账户下所有 IP 资产的 DDoS 基础防护告警信息。
  • 当前仅支持查询 IPv4 资产的告警信息。

page

Integer

否

1

  • 当前页面的页码。例如，1表示展示查询到的第 1 页事件信息。
  • 默认为1。

pageSize

Integer

否

20

  • 单个页面显示的事件数量，最大值为 50。
  • 不填写或为负值时，显示为 20。

beginDate

String

否

2023-10-01 00:00:00

  • 设置查询的起始时间。最早支持查询 180 天前的数据。
  • 不填写则默认为 180 天前。

endDate

String

否

2023-12-31 11:59:59

  • 设置查询的结束时间。
  • 不填写则默认为当前时间。

返回参数

参数

类型

示例值

描述

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

1.1.1.1

发生告警事件的 IP。

AttackType

String

UDP Flood 攻击

攻击事件类型。

PpsPeak

Integer

4532

攻击包速率峰值，单位为 pps。

BpsPeak

Integer

2406000

攻击带宽峰值，单位为 bps。

StartTime

String

2023-10-18 20:03:40

攻击开始时间。

EndTime

String

2023-10-18 21:03:49

攻击结束时间。

PeakTime

String

2023-10-18 20:17:13

攻击带宽达到峰值的时间。

Product

String

EcsInstance

IP 绑定的资产类型，为空则表示未绑定资源。

  • EcsInstance：云服务器
  • ClbInstance：负载均衡
  • AlbInstance：应用型负载均衡
  • NetworkInterface：网卡
  • Nat：NAT 网关

BlockStatus

Integer

0

黑洞状态。

  • 0：未触发黑洞
  • 1：黑洞封禁中
  • 2：黑洞封禁结束

BlockStartTime

String

2023-10-18 20:03:40

黑洞封禁开始时间。

BlockEndTime

String

2023-10-18 21:03:49

黑洞解封时间。

请求示例

POST https://open.volcengineapi.com/?Action=GetAlarm&Version=2020-12-08
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/ddos/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***
{
  "ip": "1.1.1.1",
  "beginDate": "2023-10-01 00:00:00",
  "endDate": "2023-12-31 11:59:59",
  "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": "1.1.1.1",
            "AttackType": "UDP Flood攻击",
            "PpsPeak": 4532,
            "BpsPeak": 52099000,
            "StartTime": "2023-12-28 06:17:10",
            "EndTime": "2023-12-28 06:18:40",
            "PeakTime": "2023-12-28 06:17:13",
            "Product": "EcsInstance",
            "BlockStatus": 0,
            "BlockStartTime": "",
            "BlockEndTime": ""
        },
        {
            "Id": 5268,
            "Ip": "1.1.1.1",
            "AttackType": "触发黑洞",
            "PpsPeak": 0,
            "BpsPeak": 0,
            "StartTime": "2023-10-18 20:03:40",
            "EndTime": "2023-10-18 21:03:49",
            "PeakTime": "2023-10-18 20:03:40",
            "Product": "EcsInstance",
            "BlockStatus": 2,
            "BlockStartTime": "2023-10-18 20:03:40",
            "BlockEndTime": "2023-10-18 21:03:49"
        },
    ]
}