LossAndLatencyHistoryApi
LossAndLatencyHistoryApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getDeviceLossAndLatencyHistory() : object
- Operation getDeviceLossAndLatencyHistory
- getDeviceLossAndLatencyHistoryAsync() : PromiseInterface
- Operation getDeviceLossAndLatencyHistoryAsync
- getDeviceLossAndLatencyHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getDeviceLossAndLatencyHistoryAsyncWithHttpInfo
- getDeviceLossAndLatencyHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getDeviceLossAndLatencyHistoryWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getDeviceLossAndLatencyHistoryRequest() : Request
- Create request for operation 'getDeviceLossAndLatencyHistory'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDeviceLossAndLatencyHistory()
Operation getDeviceLossAndLatencyHistory
public
getDeviceLossAndLatencyHistory(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : object
Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.
Parameters
- $serial : string
-
serial (required)
- $ip : string
-
The destination IP used to obtain the requested stats. This is required. (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
- $uplink : string = null
-
The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)
Tags
Return values
object —getDeviceLossAndLatencyHistoryAsync()
Operation getDeviceLossAndLatencyHistoryAsync
public
getDeviceLossAndLatencyHistoryAsync(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : PromiseInterface
Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.
Parameters
- $serial : string
-
(required)
- $ip : string
-
The destination IP used to obtain the requested stats. This is required. (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
- $uplink : string = null
-
The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)
Tags
Return values
PromiseInterface —getDeviceLossAndLatencyHistoryAsyncWithHttpInfo()
Operation getDeviceLossAndLatencyHistoryAsyncWithHttpInfo
public
getDeviceLossAndLatencyHistoryAsyncWithHttpInfo(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : PromiseInterface
Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.
Parameters
- $serial : string
-
(required)
- $ip : string
-
The destination IP used to obtain the requested stats. This is required. (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
- $uplink : string = null
-
The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)
Tags
Return values
PromiseInterface —getDeviceLossAndLatencyHistoryWithHttpInfo()
Operation getDeviceLossAndLatencyHistoryWithHttpInfo
public
getDeviceLossAndLatencyHistoryWithHttpInfo(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : array<string|int, mixed>
Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.
Parameters
- $serial : string
-
(required)
- $ip : string
-
The destination IP used to obtain the requested stats. This is required. (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
- $uplink : string = null
-
The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getDeviceLossAndLatencyHistoryRequest()
Create request for operation 'getDeviceLossAndLatencyHistory'
protected
getDeviceLossAndLatencyHistoryRequest(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : Request
Parameters
- $serial : string
-
(required)
- $ip : string
-
The destination IP used to obtain the requested stats. This is required. (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
- $uplink : string = null
-
The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)