文档

DescribeTraffic - 查看指定防护包上的流量情况

更新时间:

查询指定时间段内某个DDoS原生防护实例的流量统计数据。

接口说明

本接口用于查询指定时间范围内单个 DDoS 原生防护实例的流量统计数据。

说明 调用本接口时,您必须设置 InstanceId 参数,指定要查询的 DDoS 原生防护实例。

QPS 限制

本接口的单用户 QPS 限制为 1 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-antiddosbag:DescribeTrafficRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

要查询的 DDoS 原生防护实例的 ID。

说明 您可以调用 DescribeInstanceList 查询所有 DDoS 原生防护实例的 ID。

如果此处设置的实例用于代播防护,您必须设置请求参数 Interval

ddosbgp-cn-n6w203qg****
Ipnetstring

要查询的代播网段。

111.XX.XX.0/24
Ipstring

要查询的公网 IP 资产。不设置该参数表示查询 DDoS 原生防护实例防护的所有公网 IP 资产的流量统计数据。

说明 公网 IP 资产必须已经添加为 DDoS 原生防护实例的防护对象。您可以调用 DescribePackIpList 查询 DDoS 原生防护实例的所有防护对象。
39.XX.XX.96
StartTimeinteger

查询开始时间。使用时间戳格式,单位:秒。

1619798400
EndTimeinteger

查询结束时间。使用时间戳格式,单位:秒。

不设置该参数表示以当前时间作为查询结束时间。

1563445054
Intervalinteger

设置流量统计的时间间隔,单位:秒,表示将每多少秒时间段作为一个区间,统计该区间内的流量数据。默认值为 5

5
FlowTypestring

要查询的流量统计数据的类型。取值:

  • max:表示统计时间区间内的流量峰值。
  • avg:表示统计时间区间内的流量均值。
max
ResourceGroupIdstring

DDoS 原生防护实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-acfm2pz25js****
RegionIdstring

DDoS 原生防护实例所属地域 ID。

说明 您可以调用 DescribeRegions 查询 DDoS 原生防护支持的所有地域 ID。
cn-hangzhou

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

6A507DC8-F657-4C13-84E2-D1D1B9400753
FlowListobject []

查询到的流量统计数据。

Timeinteger

流量统计时间。使用时间戳表示,单位:秒。

1620951900
FlowTypestring

流量统计数据的类型。取值:

  • max:表示统计时间区间内的流量峰值。
  • avg:表示统计时间区间内的流量均值。
max
AttackPpslong

攻击流量的包转发率,单位:pps。

说明 仅在有攻击流量时,返回该数据。
0
Namestring

该次流量统计的 ID。

8e33f19e-5644-11eb-b5c1-d89d67182200
Ppsinteger

总流量的包转发率,单位:pps。

274
Kbpsinteger

总流量的宽带速率,单位:Kbps。

417
AttackBpslong

攻击流量的宽带速率,单位:bps。

说明 仅在有攻击流量时,返回该数据。
0

示例

正常返回示例

JSON格式

{
  "RequestId": "6A507DC8-F657-4C13-84E2-D1D1B9400753",
  "FlowList": [
    {
      "Time": 1620951900,
      "FlowType": "max",
      "AttackPps": 0,
      "Name": "8e33f19e-5644-11eb-b5c1-d89d67182200",
      "Pps": 274,
      "Kbps": 417,
      "AttackBps": 0
    }
  ]
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈