DescribeAttackFlow-查询 DDoS 攻击流量信息--DDoS防护-火山引擎

文档中心

立即注册

导航

DescribeAttackFlow-查询 DDoS 攻击流量信息

最近更新时间：2024.11.27 21:51:41首次发布时间：2024.07.19 19:17:47

查询 DDoS 攻击流量带宽和包速率信息，支持查询峰值或加和值。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=DescribeAttackFlow&Version=2023-03-08

调试

API Explorer

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

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeAttackFlow`	接口名称。当前 API 的名称为 `DescribeAttackFlow`。
Version	String	是	`2023-03-08`	接口版本。当前 API 的版本为 `2023-03-08`。

Body

参数	类型	是否必选	示例值	描述
BeginTime	Integer	是	`1718862780`	起始时间，秒级时间戳，结束时间应大于起始时间。
EndTime	Integer	是	`1718866380`	结束时间，秒级时间戳，结束时间应大于起始时间。
InstanceIps	Array of String	是	`["45.120.."]`	实例 IP 列表。
Tab	String	否	`Peak`	统计类型，不填写则默认为 Peak。 Sum：加和值 Peak：峰值

返回参数

参数类型示例值描述

InstanceResult Array of InstanceAttackFlowResult -- 单个实例攻击流量详情。

参数	类型	示例值	描述
InstanceResult	Array of InstanceAttackFlowResult	`--`	单个实例攻击流量详情。
OverallResult	Object of DescBizAttackFlowRes	`--`	聚合所有实例的图表。 Sum：加和值 Peak：峰值

OverallResult

Object of DescBizAttackFlowRes

--

聚合所有实例的图表。

Sum：加和值
Peak：峰值

InstanceAttackFlowResult

参数	类型	示例值	描述
Key	String	`45.120..`	实例 IP。
Val	Object of DescBizAttackFlowRes	`--`	实例对应的图表信息。

DescBizAttackFlowRes

参数	类型	示例值	描述
PeakInPps	Integer	`239`	入流量包速率峰值，单位：pps。
InKBpsFlow	Array of AttackFlowPoint	`--`	入流量带宽趋势。
InPktsFlow	Array of AttackFlowPoint	`--`	入流量包速率趋势。
PeakInKBps	Integer	`144`	入流量带宽峰值，单位：Kbps。
PeakDropPps	Integer	`3`	攻击流量包速峰值，单位：pps。
DropKBpsFlow	Array of AttackFlowPoint	`--`	攻击流量带宽趋势。
DropPktsFlow	Array of AttackFlowPoint	`--`	攻击流量包速率趋势。
PeakDropKBps	Integer	`1`	攻击流量带宽峰值，单位：Kbps。

AttackFlowPoint

参数	类型	示例值	描述
Ip	String	`45.120..`	被攻击实例的 IP。
Value	Integer	`125`	该时间点对应的数值。
Timestamp	Integer	`1718869050`	时间节点，秒级时间戳。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeAttackFlow&Version=2023-03-08
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/origin_defence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
    "BeginTime": 1718862780,
    "EndTime": 1718866380,
    "InstanceIps": [
        "45.120.**.**"
    ],
    "Tab": "Peak"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024071219171139****C111B7C2033905",
        "Action": "DescribeAttackFlow",
        "Version": "2023-03-08",
        "Service": "AdvDefence",
        "Region": "cn-beijing"
    },
    "Result": {
        "OverallResult": {
            "PeakDropKBps": 1,
            "PeakDropPps": 3,
            "DropKBpsFlow": [
                {
                    "Ip": "",
                    "Timestamp": 1720779420,
                    "Value": 0
                }
                //此处省略若干节点。
            ],
            "DropPktsFlow": [
                {
                    "Ip": "45.120.**.**",
                    "Timestamp": 1720779420,
                    "Value": 2
                }
                //此处省略若干节点。
            ],
            "PeakInKBps": 224,
            "PeakInPps": 367,
            "InKBpsFlow": [
                {
                    "Ip": "103.143.**.**",
                    "Timestamp": 1720779420,
                    "Value": 191
                }
                //此处省略若干节点。
            ],
            "InPktsFlow": [
                {
                    "Ip": "103.143.**.**",
                    "Timestamp": 1720779420,
                    "Value": 317
                }
                //此处省略若干节点。
            ]
        },
        "InstanceResult": null
    }
}