Radius Client Metrics (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/aaa_client_metrics

List the AAA client metrics. 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

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Query request for getting aaaclientmetrics

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 RadiusClientMetricsFilter

Filters according to the specifications.

element string[]

Element

interface string[]

Interfaces

site string[]

Site

max_datapoints integer

The max data points.

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.

Responses

200

Successful Operation

application/json

Schema

Schema

end_time string

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.

items ClientDetails[]
Filters according to the specifications.
Array [
aging_timeout integer
The aging timeout value.
auth_type string
The authentication type. Only closed mode and single host authentication is supported.
element_id string
The element ID.
interface_id string
The interface ID.
mac_address string
The MAC address.
reauth_timeout integer
The re-auth timeout.
reauthentication_timeout integer
The ION device authenticates or reinitializes the client after a session timeout based on the value of the Termination-Action. Values 1 and 0.
stats_start_time_ms int64
The stats start time in milliseconds.
uptime int64
Indicates the time for which the neighbor has been up.
username string
The client user name.
vlan_id integer
The virtual LAN ID.
]
start_time string

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.

Example (from schema)

{
  "end_time": "string",
  "items": [
    {
      "aging_timeout": 0,
      "auth_type": "string",
      "element_id": "string",
      "interface_id": "string",
      "mac_address": "string",
      "reauth_timeout": 0,
      "reauthentication_timeout": 0,
      "stats_start_time_ms": 0,
      "uptime": 0,
      "username": "string",
      "vlan_id": 0
    }
  ],
  "start_time": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "EMPTY_REQ_BODY"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "EMPTY_FILTER"
      },
      {
        "code": "INTERFACES_WITH_ELEMENT_MISSING"
      },
      {
        "code": "SITE_WITH_ELEMENT_MISSING"
      }
    ]
  }
}

Loading...