SteelCentral Controller Application Statistics Service v1.0

Resource: application_byte_rates

Get the byte rates for the given protocols and sites.

http://{device}/api/cmc.appstats/1.0/reports/application_byte_rates{?start_time,end_time,site_ids,resolution,traffic_type,protocols}

JSON

{
  "start_time": integer,
  "end_time": integer,
  "resolution": integer,
  "traffic_type": traffic_type,
  "protocols": [ protocol_id ],
  "site_ids": [
    integer
  ],
  "wan_inbound": [
    multiple
  ],
  "wan_outbound": [
    multiple
  ],
  "lan_inbound": [
    multiple
  ],
  "lan_outbound": [
    multiple
  ]
}

{
  "start_time": integer,
  "end_time": integer,
  "resolution": integer,
  "traffic_type": traffic_type,
  "protocols": [ protocol_id ],
  "site_ids": [
    integer
  ],
  "wan_inbound": [
    multiple
  ],
  "wan_outbound": [
    multiple
  ],
  "lan_inbound": [
    multiple
  ],
  "lan_outbound": [
    multiple
  ]
}

Property Name	Type	Description	Notes
application_byte_rates	<object>	Get the byte rates for the given protocols and sites.	Required properties: [start_time, end_time, resolution, traffic_type, wan_inbound, wan_outbound, lan_inbound, lan_outbound];
application_byte_rates.start_time	<integer>	Unix epoch timestamp.
application_byte_rates.end_time	<integer>	Unix epoch timestamp.
application_byte_rates.resolution	<integer>	The resolution in which the statistics samples have to be returned.
application_byte_rates.traffic_type	<traffic_type>	The traffic type desired.	Values: any, optimized, passthrough;
application_byte_rates.protocols	<array of <protocol_id>>	List of Layer7 protocol IDs. If this property is not present then it means the data is for all protocols.	Optional;
application_byte_rates.protocols[items]	<protocol_id>	The numeric Vineyard ID for a protocol
application_byte_rates.site_ids	<array of <integer>>	List of site IDs. If this property is not present then it means the data is for all sites.	Optional;
application_byte_rates.site_ids[items]	<integer>	The Site ID value.
wan_inbound	<array of <multiple>>	WAN Inbound byte rates
wan_inbound[items]	<multiple>	The byte rate value.
wan_inbound[items].oneOf[0]	<byte_rate>	Bytes per second
wan_inbound[items].oneOf[1]	<null>	A value can be missing in which case the element is type null.
wan_outbound	<array of <multiple>>	WAN Outbound byte rates
wan_outbound[items]	<multiple>	The byte rate value.
wan_outbound[items].oneOf[0]	<byte_rate>	Bytes per second
wan_outbound[items].oneOf[1]	<null>	A value can be missing in which case the element is type null.
lan_inbound	<array of <multiple>>	LAN Inbound byte rates
lan_inbound[items]	<multiple>	The byte rate value.
lan_inbound[items].oneOf[0]	<byte_rate>	Bytes per second
lan_inbound[items].oneOf[1]	<null>	A value can be missing in which case the element is type null.
lan_outbound	<array of <multiple>>	LAN Outbound byte rates
lan_outbound[items]	<multiple>	The byte rate value.
lan_outbound[items].oneOf[0]	<byte_rate>	Bytes per second
lan_outbound[items].oneOf[1]	<null>	A value can be missing in which case the element is type null.

Links

application_byte_rates: get

GET http://{device}/api/cmc.appstats/1.0/reports/application_byte_rates{?start_time,end_time,site_ids,resolution,traffic_type,protocols}

Response Body

Returns an application_byte_rates data object.

Resource: top_applications

The top N applications ordered by WAN average for the given traffic_type and time range.

http://{device}/api/cmc.appstats/1.0/reports/top_applications{?start_time,site_id,limit,end_time,traffic_type,resolution}

JSON

{
  "start_time": integer,
  "end_time": integer,
  "resolution": integer,
  "traffic_type": traffic_type,
  "limit": integer,
  "top_applications": [
    {
      "protocol_id": integer,
      "wan_avg": number
    }
  ]
}

{
  "start_time": integer,
  "end_time": integer,
  "resolution": integer,
  "traffic_type": traffic_type,
  "limit": integer,
  "top_applications": [
    {
      "protocol_id": integer,
      "wan_avg": number
    }
  ]
}

Property Name	Type	Description	Notes
top_applications	<object>	The top N applications ordered by WAN average for the given traffic_type and time range.	Required properties: [start_time, end_time, resolution, traffic_type, limit, top_applications];
top_applications.start_time	<integer>	Unix epoch timestamp.
top_applications.end_time	<integer>	Unix epoch timestamp.
top_applications.resolution	<integer>	The resolution in which the statistics samples have to be returned.
top_applications.traffic_type	<traffic_type>	The traffic type desired.	Values: any, optimized, passthrough;
top_applications.limit	<integer>	The limit specifying the 'N' value for top N applications.	Minimum 1;
top_applications.top_applications	<array of <object>>	The list of top N applications.
top_applications.top_applications[items]	<object>	Each item is an object describing a protocol and it's corresponding statistics.	Required properties: [protocol_id, wan_avg];
protocol_id	<integer>	L7 protocol id
wan_avg	<number>	Average WAN byte rates corresponding to the protocol_id in this item. The average is calculated after combining wan_inbound and wan_outbound byte rates.	Minimum 0.0;

Links

top_applications: get

GET http://{device}/api/cmc.appstats/1.0/reports/top_applications{?start_time,site_id,limit,end_time,traffic_type,resolution}

Response Body

Returns a top_applications data object.

Resource: global_config

Global application statistics configuration

http://{device}/api/cmc.appstats/1.0/global_config

JSON

{
  "enabled": boolean
}

{
  "enabled": boolean
}

Property Name	Type	Description	Notes
global_config	<object>	Global application statistics configuration	Required properties: [enabled];
global_config.enabled	<boolean>	Enable application statistics collection

Links

global_config: get

GET http://{device}/api/cmc.appstats/1.0/global_config

Response Body

Returns a global_config data object.

global_config: set

PUT http://{device}/api/cmc.appstats/1.0/global_config

Request Body

Provide a global_config data object.

Response Body

Returns a global_config data object.

Resource: site_configs

List of site_configs

http://{device}/api/cmc.appstats/1.0/site_configs

JSON

[
  {
    "id": integer,
    "site_id": integer,
    "site_type_id": integer,
    "enabled": boolean
  }
]

[
  {
    "id": integer,
    "site_id": integer,
    "site_type_id": integer,
    "enabled": boolean
  }
]

Property Name	Type	Description	Notes
site_configs	<array of <items>>	List of site_configs
items	<object>	Site specific application statistics configuration	Required properties: [enabled];
id	<integer>	A unique identifier	Read-only;
items.site_id	<integer>	Site ID	Optional;
items.site_type_id	<integer>	Site type ID	Optional;
items.enabled	<boolean>	Enable application statistics
items.oneOf[0]	<object>		Required properties: [site_id];
items.oneOf[0].<prop>	<any>		Optional;
items.oneOf[1]	<object>		Required properties: [site_type_id];
items.oneOf[1].<prop>	<any>		Optional;

Links

site_configs: create

POST http://{device}/api/cmc.appstats/1.0/site_configs

Request Body

Provide a site_config data object.

Response Body

Returns a site_config data object.

site_configs: get

GET http://{device}/api/cmc.appstats/1.0/site_configs

Response Body

Returns a site_configs data object.

Resource: site_config

Site specific application statistics configuration

http://{device}/api/cmc.appstats/1.0/site_configs/items/{id}

JSON

{
  "id": integer,
  "site_id": integer,
  "site_type_id": integer,
  "enabled": boolean
}

{
  "id": integer,
  "site_id": integer,
  "site_type_id": integer,
  "enabled": boolean
}

Property Name	Type	Description	Notes
site_config	<object>	Site specific application statistics configuration	Required properties: [enabled];
id	<integer>	A unique identifier	Read-only;
site_config.site_id	<integer>	Site ID	Optional;
site_config.site_type_id	<integer>	Site type ID	Optional;
site_config.enabled	<boolean>	Enable application statistics
site_config.oneOf[0]	<object>		Required properties: [site_id];
site_config.oneOf[0].<prop>	<any>		Optional;
site_config.oneOf[1]	<object>		Required properties: [site_type_id];
site_config.oneOf[1].<prop>	<any>		Optional;

Links

site_config: get

GET http://{device}/api/cmc.appstats/1.0/site_configs/items/{id}

Response Body

Returns a site_config data object.

site_config: set

PUT http://{device}/api/cmc.appstats/1.0/site_configs/items/{id}

Request Body

Provide a site_config data object.

Response Body

Returns a site_config data object.

site_config: delete

DELETE http://{device}/api/cmc.appstats/1.0/site_configs/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

site_config: instances

All instances of site configurations.

Related resource

site_configs

Type: serial

The serial number of the appliance

JSON

string

string

Property Name	Type	Description	Notes
serial	<string>	The serial number of the appliance	Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';

Type: protocol_id

The numeric Vineyard ID for a protocol

JSON

integer

integer

Property Name	Type	Description	Notes
protocol_id	<integer>	The numeric Vineyard ID for a protocol

Type: traffic_type

The traffic type desired.

JSON

string

string

Property Name	Type	Description	Notes
traffic_type	<string>	The traffic type desired.	Values: any, optimized, passthrough;

Type: byte_rate

Bytes per second

JSON

number

number

Property Name	Type	Description	Notes
byte_rate	<number>	Bytes per second	Minimum 0.0;

Type: byte_rate_series

Time series of byte rate values.

JSON

[
  multiple
]

[
  multiple
]

Property Name	Type	Description
byte_rate_series	<array of <multiple>>	Time series of byte rate values.
byte_rate_series[items]	<multiple>	The byte rate value.
byte_rate_series[items].oneOf[0]	<byte_rate>	Bytes per second
byte_rate_series[items].oneOf[1]	<null>	A value can be missing in which case the element is type null.

Type: identifier

A unique identifier

JSON

integer

integer

Property Name	Type	Description	Notes
identifier	<integer>	A unique identifier