DescBizFlow-查询业务流量信息--DDoS防护-火山引擎

文档中心

立即注册

导航

DescBizFlow-查询业务流量信息

最近更新时间：2024.06.27 22:21:31首次发布时间：2024.06.27 22:21:31

根据防护实例 ID 或攻击事件 ID 查询特定时间范围内的业务流量数据。

注意事项

参数优先级说明：攻击事件 ID > 防护资源 IP > 实例 ID。
实例 ID 和攻击事件 ID 至少需要传入其一。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=DescBizFlow&Version=2022-01-01

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescBizFlow`	接口名称。当前 API 的名称为 `DescBizFlow`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
InsId	Integer	否	`20`	防护实例的 ID，攻击事件 ID 为空时必填，可调用DescInstanceList接口获取具体值。说明其请求优先级低于攻击事件 ID。
Ip	String	否	`180.184.180.**`	防护资源 IP，为空时表示查询当前实例下所有防护资源 IP。说明其请求优先级高于实例 ID，但低于攻击事件 ID。
BeginTime	Integer	否	`1718885400`	查询起始时间，秒级时间戳。为空时则表示 30 分钟前。
EndTime	Integer	否	`1718889000`	查询结束时间，秒级时间戳。为空时则表示当前时间。
AtkId	Integer	否	`907`	攻击事件的 ID，防护实例 ID 为空时必填，可调用DescAttackEvent接口获取具体值。说明该参数有传入值时，其他参数可为空，且其请求优先级大于实例 ID 和防护资源 IP。

返回参数

参数	类型	示例值	描述
BizKBpsFlow	Array of BizKBpsFlow	`--`	业务带宽趋势。
BizPktsFlow	Array of BizPktsFlow	`--`	业务包速率趋势。
PeakBizKBps	Integer	`111`	业务带宽峰值。
PeakBizPps	Integer	`31`	业务包速率峰值。

BizKBpsFlow

参数	类型	示例值	描述
Time	String	`1718885520`	业务带宽数据采集时间，间隔为 60 秒。
Value	Integer	`111`	该采集时间点的业务带宽值，单位为 Kbps。

BizPktsFlow

参数	类型	示例值	描述
Time	String	`1718885520`	业务包速率数据采集时间，间隔为 60 秒。
Value	Integer	`31`	该采集时间点的业务包速率值，单位为 Pkts。

请求示例

GET https://open.volcengineapi.com/?Action=DescBizFlow&Version=2022-01-01&InsId=20&Ip=180.184.180.**&BeginTime=1718885400&EndTime=1718889000&AtkId=907
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

返回示例

{
    "ResponseMetadata": {
        "Action": "DescBizFlow",
        "Region": "cn-beijing",
        "RequestId": "20230604110420****100232280022D31",
        "Service": "origin_defence",
        "Version": "2022-01-01"
    },
    "Result": {
        "BizKBpsFlow": [
            {
                "Time": "1718885400",
                "Value": 1
            },  
            //此处省略若干节点
            {
                "Time": "1718885520",
                "Value": 111
            }
        ],
        "BizPktsFlow": [ 
            {
            "Time": "1718885400",
            "Value": 1
            }, 
            //此处省略若干节点
            {
                "Time": "1718885520",
                "Value": 31
            }
        ],
        "PeakBizKBps": 111,
        "PeakBizPps": 31
    }
}