System metrics for Version 2.3 (v2.3)

POST 
/v2.3/api/tenants/:tenant_id/monitor/sys_metrics

Get system metrics like CPU, Memory and Disk usage. External API used for stats queries. In addition to CPUUsage, Memory Usage and DiskUsage InterfaceBandwidthUsage, InterfaceDroppedPackets, InterfaceErrors, InterfaceFifoErrors, InterfaceIngressCRCErrors, InterfaceIngressFrameErrors, InterfaceEgressCarrierErrors additional metrics like InterfacePoePowerConsumption, DeviceTemperature. Below are the tenet for queries

• interval is required
• start_time, end_time and max_datapoints are optional with the following restrictions, at least one of them needs to be specified. all the three can not be specified, as the result is ambiguous. Note
• Start time, if not specified, default to epoch.
• End time, if not specified, default to now.
• Limit, if not specified, defaults to None..
• Start and end times need to be specified in ISO8601 UTC format.
• Metrics need to specified according to 2.1 specifications. Invalid metrics will be ignored and the result will not include them.
• Filters need to be specified according to the specifications.

Request

Path Parameters

tenant_id stringrequired

Tenant Id

application/json

Body

Query request for getting sysmetrics

end_time date

The end time to get the system metrics.

filter SysMetricsFilter

Filters according to the specifications.

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]

The time period of the system metrics query.

max_datapoints int32

The max data points.

metrics Metrics[]required
The details of the 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 system metric. Maz size = 128.

start_time date

The start time to get the system metrics.

view View

View the system metric 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

200

Successful Operation

application/json

Schema

Schema

metrics MetricArray[]
The details of the 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.
]
]

Example (from schema)

{
  "metrics": [
    {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2024-07-29T15:51:28.071Z",
                  "filter_property_id": "string",
                  "links": [
                    "string"
                  ],
                  "max_value_time": "2024-07-29T15:51:28.071Z",
                  "ninetieth_percentile": 0,
                  "sites": [
                    "string"
                  ],
                  "value": 0
                }
              ],
              "statistics": {}
            }
          ],
          "interval": "string",
          "name": "string",
          "unit": "string",
          "view": {}
        }
      ]
    }
  ]
}

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": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "METRIC_UNIT_NOT_SUPPORTED"
      },
      {
        "code": "UNSUPPORTED_FILTER_IN_VERSION"
      },
      {
        "code": "UNSUPPORTED_FILTER_FOR_METRIC"
      },
      {
        "code": "MISSING_INTERFACE_FILTER_PROPERTY"
      },
      {
        "code": "MISSING_ELEMENT_FILTER_PROPERTY"
      },
      {
        "code": "UNSUPPORTED_DIRECTION_FILTER"
      },
      {
        "code": "DIRECTION_FILTER_EMPTY"
      },
      {
        "code": "DIRECTION_VIEW_NOT_SUPPORTED"
      },
      {
        "code": "MAX_DATAPOINTS_END_TIME"
      }
    ]
  }
}

500

Internal Server Error

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"
    }
  ]
}

Loading...