Get Message Client Monitor

Get Message Client Monitor

Gets monitoring information related to registered message client.

Request
URI
GET
https://{api_host}/rest/monitor/v1/message-clients/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MessageClientMonitorInfo of type(s) */* 
{
    "client_type": "EDGE",
    "id": "EDGE-665b09dd-92cc-4da5-8521-1c9a4361493b",
    "last_disconnect_timestamp": 1582029025748,
    "message_client_status": "CONNECTED"
}
string
client_type
Optional

The message client type.

  • EDGE: EDGE Gateway user.
  • CSMS: CSMS user.
Possible values are : EDGE, CSMS,
string
id
Optional

Unique ID representing the message client.

integer As int64 As int64
last_disconnect_timestamp
Optional

The timestamp in milliseconds when the message client was last seen. Measured as epoch time.

string
message_client_status
Optional

The message client status.

  • CONNECTED: Connected.
  • DISCONNECTED: Disconnected.
  • REGISTERED: Registered.
Possible values are : CONNECTED, DISCONNECTED, REGISTERED,

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
Monitor Operations
GET
Get App Volumes Manager Monitor Info
GET
Get App Volumes Manager Monitor Info V2
GET
Get Connection Server Monitor Info V2
GET
Get Connection Server Monitor Info V3
GET
Get Desktop Monitor Info
GET
Get Event Database Monitor
GET
Get Farm Monitor Info
GET
Get Gateway Monitor Info
GET
Get Gateway Monitor Info V2
GET
Get License Usage Metrics
GET
Get Message Client Monitor
GET
Get Pod Monitor Info V2
GET
Get Pod Session Metrics Info
GET
Get RDS Server Monitors
GET
Get SAML Authenticator Monitor Info
GET
Get Session Metrics
GET
Get System Metrics Info
GET
Get True SSO Monitor Info
GET
Get View Composer By VC Id
GET
Get Virtual Center Monitor Info
GET
Get Virtual Center Monitor Info V3
GET
List AD Domain Monitor Infos V2
GET
List AD Domain Monitor Infos V3
GET
List AD Domain Monitors
GET
List App Volumes Manager Monitor Info V1
GET
List App Volumes Manager Monitor Info V2
GET
List Connection Server Monitors
GET
List Connection Server Monitors V2
GET
List Connection Server Monitors V3
GET
List Desktop Monitors
GET
List Desktop Pool Metrics
GET
List Desktop Pool Or Farm Datastore Usage Info
GET
List Farm Monitors
GET
List Gateway Monitor Info V1
GET
List Gateway Monitor Info V2
GET
List Gateway Monitor Info V3
GET
List Global Desktop Entitlements Metrics
GET
List Health Metrics Info
GET
List Message Clients Monitors
GET
List Pod Monitor Infos V1
GET
List Pod Monitor Infos V2
GET
List RDS Server Monitors
GET
List SAML Authenticator Monitors V1
GET
List SAML Authenticator Monitors V2
GET
List True SSO Monitor Infos
GET
List View Composer Monitors V1
GET
List View Composer Monitors V2
GET
List Virtual Center Monitors
GET
List Virtual Center Monitors V2
GET
List Virtual Center Monitors V3