Clients

This is a list of clients at this site. A client at a site may connect to a topic at a remote site, (child or parent) Thus if a websocket client connect to the top site, requesting a topic at an edge site, the client will occcur at the topsite whereas the topic resides at the edgesite

Retrieve all client infos

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/volga/clients
Response samples
- name: config-events
  location: local
  topic: system:config-events
  tenant: telco
  host: h01
  kind: producer
  num-messages: 8
  status: up
  status-info: producing-locally
  buffered-undelivered: 0
  reconnects: 0
  time-disconnected: 0s
  last-disconnected-time: 2023-03-15T22:01:34Z
  time-connected: 3d23h29m9s
  

Retrieve a client info

SecurityaccessToken
Request
path Parameters
client-info-name
required
string

Since the name of a producer need not be unique, if we have several producers with the same name at a site, the producer name may be prepended with a number as in "myprod-1" etc

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/volga/clients/{client-info-name}
Response samples
name: config-events
location: local
topic: system:config-events
tenant: telco
host: h01
kind: producer
num-messages: 8
status: up
status-info: producing-locally
buffered-undelivered: 0
reconnects: 0
time-disconnected: 0s
last-disconnected-time: 2023-03-15T22:01:34Z
time-connected: 3d23h29m9s