Get Gateway Monitor Info

Gets monitoring information related to a Gateway.

Request

URI

GET

https://{api_host}/rest/monitor/v1/gateways/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns GatewayMonitorInfoV2 of type(s) */*

{
    "active_connection_count": 1234,
    "blast_connection_count": 10,
    "details": {
        "address": "uag1.example.com",
        "internal": false,
        "type": "UAG",
        "version": "3.5.0"
    },
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "last_updated_timestamp": 1582029025748,
    "name": "uag1",
    "pcoip_connection_count": 90,
    "status": "OK"
}

integer As int32 As int32

active_connection_count

Optional

Number of active connections for the gateway. Includes PCoIP and BLAST connection counts.

integer As int32 As int32

blast_connection_count

Optional

Number of BLAST connections for the gateway.

GatewayMonitorDetails

details

Optional

details

string

Optional

Unique ID of the Gateway.

integer As int64 As int64

last_updated_timestamp

Optional

The timestamp in milliseconds when the last update was obtained. Measured as epoch time.

string

name

Optional

Gateway name.

integer As int32 As int32

pcoip_connection_count

Optional

Number of PCoIP connections for the gateway.

string

status

Optional

Status of the Gateway.

NOT_CONTACTED: There has been no contact from the gateway.
PROBLEM: The gateway has reported a problem.
STALE: Gateway is stale. Gateway will be marked as stale when Connection Server does not receive any request from the Gateway in last two successive intervals.
OK: The Gateway is working as expected.

Possible values are : NOT_CONTACTED, PROBLEM, STALE, OK,

401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Authentication