Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Query Server Status

ApiRef2.png GET /server/status
Available since 8.0.100.00

Description

Queries the status of the Universal Contact Server (UCS). The status that is returned includes in particular the Server Mode (production or maintenance), but it also includes additional information and valuable counters to analyse the activity of the UCS. Important.png Some counters, such as "request_today", "client_errors_today", and "server_errors_today", are not persistent. They are automatically reset if the UCS is restarted.

Operation

Query Server Status
ID CV.WS.STAT
Method GET
URL /server/status

Response

The Context Management Service API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTPResponseCodesandErrors for further details on the possible codes that this operation can return.

Response
HTTP code 200
HTTP message OK
Name   Type   Description
Body
version string The version of the UCS.
system_time date/time<ref name="format">The date/time format is "yyyy-MM-ddTHH:mm:ss.SSSZ".</ref> The system time
mode token
  • production
  • maintenance
The Server Mode.
max_memory long The maximum amount of memory the JVM will attempt to use, in KB.
allocated_memory integer The amount of memory currently in use by the JVM, in KB.
free_memory integer The total memory available to the JVM, in KB.
started date/time<ref name="format"/> Start date of the UCS.
last_request date/time<ref name="format"/> The time of the last web service request.

<references />

Example

Operation

 GET /server/status

Result

 "max_memory" : 518464,
 "server_errors_today" : 0,
 "client_errors_today" : 0,
 "request_today" : 0,
 "system_time" : "2010-02-24T15:56:46.369Z",
 "used_memory" : 7947,
 "allocated_memory" : 63936,
 "started" : "2010-02-24T14:35:28.668Z",
 "free_memory" : 55989,
 "last_request" : "2010-02-24T14:35:27.964Z",
 "mode" : "production",
 "version" : "8.0.100.11"
This page was last edited on November 23, 2017, at 16:00.

Feedback

Comment on this article:

blog comments powered by Disqus