v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Get cluster member capacity trend

Retrieves client and device capacity trend data for a specific gateway in a gateway cluster based on specified timestamp range.

get/network-monitoring/v1/clusters/{cluster-name}/capacity-trends/{serial-number}

Path parameters

cluster-namestring const required

The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.

Example:cluster 1

The name of the cluster formed by the gateway.

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Query parameters

filterstring

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields, operators and value format are in the below given table.

Field	Operators	Format
timestamp	gt and lt	Date-time (RFC 3339 timestamp in UTC+0) string

The operators are implemented as follows:

gt: Used to indicate the start of the timestamp range.
lt: Used to indicate the end of the timestamp range.

Response

The response object provides the client and device capacity trend of a gateway cluster member.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "graph": {
    "keys": [
      "active_client_count",
      "standby_client_count",
      "cluster_client_max_capacity",
      "active_client_percentage",
      "standby_client_percentage"
    ],
    "samples": [
      {
        "timestamp": "2024-03-12T07:20:50.52Z"
      }
    ]
  },
  "id": "GW00000001",
  "type": "network-monitoring/gateway-monitoring"
}