Skip to main content

Get Radius Metrics (v2.0)

POST 

/sdwan/v2.0/api/monitor/aaa_metrics

List the radius metrics of eapol rx and tx messages. The start time, end time, and max datapoints attibutes are optional with at least one of them specified. All three attributes can not be specified, as the result will be ambiguous.

Request

Body

Query request for getting aaametrics

    end_time date

    The end time to get the client metrics. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.

    filter RadiusMetricsFilter

    Filters according to the specifications.

    client_mac_address string[]

    The client mac address.

    direction string

    Possible values: [Ingress, Egress]

    The direction of the traffic.

    element string[]

    The element.

    interface string[]

    The configured interfaces.

    site string[]

    The site.

    interval stringrequired

    Possible values: [10sec, 1min, 5min, 1hour, 1day, 1month]

    Interval: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property)

    max_datapoints int32

    The max data points.

    metrics Metrics[]required

    The details of the radius metrics.

  • Array [
  • name stringrequired

    Name: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)

    statistics string[]required

    Statistics: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property)

    unit stringrequired

    Unit: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)

  • ]
  • name string

    The description of the client metrics. Maz size = 128.

    start_time date

    The start time to get the client metrics. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.

    view View

    View the active RADIUS server details.

    individual string

    Possible values: [ELEMENT, INTERFACE, CELLULAR_MODULE, DIRECTION, SITE, APP, PATH, PATH_TYPE, WANINTERFACE, PRIORITY, TRAFFIC_TYPE, COMMON, CLIENT_MAC_ADDRESS, USER, USER_EMAIL, RESOLUTION_QUALITY, None]

    The individual view values.

    summary boolean

    The summary of the view.

Responses

Successful Operation

Schema
    metrics MetricArray[]

    The details of the radius metrics.

  • Array [
  • series Series[]

    Series

  • Array [
  • data Data[]

    Data

  • Array [
  • datapoints Datapoints[]

    Datapoints

  • Array [
  • duration date-time

    The date and time of the series.

    filter_property_id string

    The filter property ID.

    links string[]

    Links

    max_value_time date-time
    ninetieth_percentile number

    Ninetieth Percentile

    sites string[]

    The sites.

    value number

    The values of the filter.

  • ]
  • statistics object

    Statistics

  • ]
  • interval string

    The interval time.

    name string

    The name.

    unit string

    Unit

    view object

    View the active series details.

  • ]
  • ]
Loading...