UplinksLossAndLatencyApi
UplinksLossAndLatencyApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getOrganizationDevicesUplinksLossAndLatency() : object
- Operation getOrganizationDevicesUplinksLossAndLatency
- getOrganizationDevicesUplinksLossAndLatencyAsync() : PromiseInterface
- Operation getOrganizationDevicesUplinksLossAndLatencyAsync
- getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo
- getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getOrganizationDevicesUplinksLossAndLatencyRequest() : Request
- Create request for operation 'getOrganizationDevicesUplinksLossAndLatency'
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 —getOrganizationDevicesUplinksLossAndLatency()
Operation getOrganizationDevicesUplinksLossAndLatency
public
getOrganizationDevicesUplinksLossAndLatency(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : object
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
Parameters
- $organization_id : string
-
organization_id (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 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
- $uplink : string = null
-
Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
- $ip : string = null
-
Optional filter for a specific destination IP. Default will return all destination IPs. (optional)
Tags
Return values
object —getOrganizationDevicesUplinksLossAndLatencyAsync()
Operation getOrganizationDevicesUplinksLossAndLatencyAsync
public
getOrganizationDevicesUplinksLossAndLatencyAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : PromiseInterface
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
Parameters
- $organization_id : string
-
(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 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
- $uplink : string = null
-
Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
- $ip : string = null
-
Optional filter for a specific destination IP. Default will return all destination IPs. (optional)
Tags
Return values
PromiseInterface —getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo()
Operation getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo
public
getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : PromiseInterface
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
Parameters
- $organization_id : string
-
(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 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
- $uplink : string = null
-
Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
- $ip : string = null
-
Optional filter for a specific destination IP. Default will return all destination IPs. (optional)
Tags
Return values
PromiseInterface —getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo()
Operation getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo
public
getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : array<string|int, mixed>
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
Parameters
- $organization_id : string
-
(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 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
- $uplink : string = null
-
Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
- $ip : string = null
-
Optional filter for a specific destination IP. Default will return all destination IPs. (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
getOrganizationDevicesUplinksLossAndLatencyRequest()
Create request for operation 'getOrganizationDevicesUplinksLossAndLatency'
protected
getOrganizationDevicesUplinksLossAndLatencyRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : Request
Parameters
- $organization_id : string
-
(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 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (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 5 minutes. The default is 5 minutes. (optional)
- $uplink : string = null
-
Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
- $ip : string = null
-
Optional filter for a specific destination IP. Default will return all destination IPs. (optional)