Information about the streams on monitored nodes can be obtained from backend server with Websocket API or REST API.
Current streams information can be obtained with /api/stream/list request
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Where
Response data are obtained from current metrics cache.
Current instantaneous metric values for stream published or played on WCS can be obtained with /api/stream/metrics request
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Здесь:
Response also contains current instantaneous metric values from cache.
Stream history information can be obtained with /api/stream/history request
API | Request | Response | Response status | ||
---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Where
If node Id is set, the response will contain only that node stream history information. If Id is not set, the response will contain all the streams history on backend server corresponding to the other query criteria.
If maximum stream count in DB selection is set to 0, all stream data will be selected from DB. This query can be terminated by timeout if streams count in DB is too big, so it is not recommended to send the query without limits.