Queries traffic statistics of an Anti-DDoS Origin Enterprise instance.

Note Anti-DDoS Origin API operations are available for only Anti-DDoS Origin Enterprise users.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description 
Action String Yes DescribeTraffic

The operation that you want to perform. Set the value to DescribeTraffic.

EndTime Integer Yes 1563445054

The timestamp that specifies the end of the time range to query. Unit: seconds. The timestamp follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 Thursday, 1 January 1970.

Interval Integer Yes 1000

The interval between queries. Unit: seconds.

StartTime Integer Yes 1560853054

The timestamp that specifies the beginning of the time range to query. Unit: seconds. The timestamp follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 Thursday, 1 January 1970.

InstanceId String No ddosbgp-cn-*****

The ID of the Anti-DDoS Origin Enterprise instance.

Note You must specify either the InstanceId or Ip parameter, or specify both parameters.
Ip String No 1.1.1.1

The IP address of the protection target.

Note You must specify either the InstanceId or Ip parameter, or specify both parameters.
ResourceGroupId String No test

The ID of the resource group.

Response parameters

Parameter Type Example Description 
FlowList Array

The traffic statistics of each interval.

FlowType String max

The statistical aggregation method of the traffic statistics. Valid values:

  • avg: indicates the average traffic statistics within the specified time range.
  • max: indicates the maximum traffic statistics within the specified time range.
Kbps Integer 8

The throughput of the instance. Unit: Kbit/s.

Name String 73765106-54e7-11e9-aab0-d89d67182200

The ID of an entry that includes traffic statistics of the specified time range.

Pps Integer 9

The packet forwarding rate of the instance. Unit: packets per second (PPS).

Time Integer 1560857000

The timestamp that indicates the start time of the specified time range.

RequestId String 6A507DC8-F657-4C13-84E2-D1D1B9400753

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeTraffic
&EndTime=1563445054
&Interval=1000
&StartTime=1560853054
&InstanceId=ddosbgp-cn-*****
& <Common request parameters>

Sample success responses

XML format

<DescribeTraffic>
	  <RequestId>6A507DC8-F657-4C13-84E2-D1D1B9400753</RequestId>
	  <FlowList>
		    <Name>73765106-54e7-11e9-aab0-d89d67182200</Name>
		    <Pps>25</Pps>
		    <Time>1560855000</Time>
		    <FlowType>max</FlowType>
		    <Kbps>17</Kbps>
	  </FlowList>
	  <FlowList>
		    <Name>73765106-54e7-11e9-aab0-d89d67182200</Name>
		    <Pps>9</Pps>
		    <Time>1560857000</Time>
		    <FlowType>max</FlowType>
		    <Kbps>8</Kbps>
	  </FlowList>
</DescribeTraffic>

JSON format

{
	"FlowList":[
		{
			"Pps":25,
			"Name":"73765106-54e7-11e9-aab0-d89d67182200",
			"Time":1560855000,
			"FlowType":"max",
			"Kbps":17
		},
		{
			"Pps":9,
			"Name":"73765106-54e7-11e9-aab0-d89d67182200",
			"Time":1560857000,
			"FlowType":"max",
			"Kbps":8
		}
	],
	"RequestId":"6A507DC8-F657-4C13-84E2-D1D1B9400753"
}

Error codes

For a list of error codes, visit the API Error Center.