Get aggregate tunnel stats data for a single appliance filter by query parameters.

get http://127.0.0.1:8080/stats/aggregate/tunnel

This operation is used to retrieve tunnel aggregate stats for a single appliance. Depend on what query parameters are provided. The response format may look different.

Query Params

nePk

string

required

Appliance internal id to filter from.

startTime

integer

required

Long(Signed 64 bits) value of EPOCH time indicating the starting time boundary of data time range

endTime

integer

required

Long(Signed 64 bits) value of EPOCH time indicating the ending time boundary of data time range

granularity

string

required

Data granularity filtering whether data is minutely data, hourly data or daily data.

tunnelName

string

Filter for data which belongs to tunnel with name {tunnelName}

boolean

Using IP as key for grouping stats instead of using internal appliance id as key.

metric

string

If this query parameter is given, we aggregate stats in a way that we sort stats by this {metric}. This query parameter could also be used with {top} query parameters to limit how many items we want to retrieve.

top

integer

This parameter should be provided together with {metric} as this query parameter is used to indicate top x items of a metric. Example, if metric=throughput&top=10 is provided, you're saying you want to retrieve top 10 tunnels by throughput.

overlay

string

when it is 'all',return all bonded tunnels;when it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.

format

string

The only format other than JSON we support currently is CSV, so format=csv.

groupByNE

boolean

Boolean value indicating whether you want to group aggregate stats by appliance, if true is provided, there will be an extra level of key inside each tunnel stats object indicating what appliance the inner stats object belongs to. Default value is true.

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'http://127.0.0.1:8080/stats/aggregate/tunnel?granularity=minute' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200No response was specified