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

使用说明

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

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeTraffic

要执行的操作。取值:DescribeTraffic

InstanceId String ddosbgp-cn-n6w203qg****

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

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

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

Ipnet String 111.XX.XX.0/24

要查询的代播网段。

Ip String 39.XX.XX.96

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

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

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

EndTime Integer 1563445054

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

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

Interval Integer 5

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

FlowType String max

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

  • max:表示统计时间区间内的流量峰值。
  • avg:表示统计时间区间内的流量均值。
ResourceGroupId String rg-acfm2pz25js****

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

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

RegionId String cn-hangzhou

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

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String 6A507DC8-F657-4C13-84E2-D1D1B9400753

本次请求的ID。

FlowList Array of Flow

查询到的流量统计数据。

Time Integer 1620951900

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

FlowType String max

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

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

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

说明 仅在有攻击流量时,返回该数据。
Name String 8e33f19e-5644-11eb-b5c1-d89d67182200

该次流量统计的ID。

Pps Integer 274

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

Kbps Integer 417

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

AttackBps Long 0

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTraffic
&StartTime=1619798400
&InstanceId=ddosbgp-cn-n6w203qg****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeTrafficResponse>
	<FlowList>
		<Pps>274</Pps>
		<Kbps>417</Kbps>
		<FlowType>max</FlowType>
		<Time>1620890570</Time>
		<Name>8e33f19e-5644-11eb-b5c1-d89d67182200</Name>
	</FlowList>
	<FlowList>
		<Pps>10</Pps>
		<Kbps>62</Kbps>
		<FlowType>max</FlowType>
		<Time>1620951900</Time>
		<Name>8e33f19e-5644-11eb-b5c1-d89d67182200</Name>
	</FlowList>
	<RequestId>3986BADC-F6F7-4874-BF71-E5306BABBE75</RequestId>
</DescribeTrafficResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "FlowList" : [ {
    "Pps" : 274,
    "Kbps" : 417,
    "FlowType" : "max",
    "Time" : 1620890570,
    "Name" : "8e33f19e-5644-11eb-b5c1-d89d67182200"
  }, {
    "Pps" : 10,
    "Kbps" : 62,
    "FlowType" : "max",
    "Time" : 1620951900,
    "Name" : "8e33f19e-5644-11eb-b5c1-d89d67182200"
  } ],
  "RequestId" : "3986BADC-F6F7-4874-BF71-E5306BABBE75"
}

错误码

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