GetStatus ========= Retrieve information and status about the system. Any authenticated user can call this command. No additional permission or blob input is required. Parameters ---------- .. list-table:: :header-rows: 1 :widths: 22 18 60 * - Parameter - Type / required - Default and behavior * - ``all`` - Boolean / optional - ``false``; return all implemented optional status measurements. * - ``connection_count`` - Boolean / optional - ``false``; return the number of open client connections. * - ``memory_utilization`` - Boolean / optional - ``false``; return resident memory divided by machine memory. * - ``memory_utilization_gb`` - Boolean / optional - ``false``; return resident memory in decimal GB (10^9 bytes). * - ``queries_running`` - Boolean / optional - ``false``; return currently running queries. * - ``queries_queued`` - Boolean / optional - ``false``; return queued queries. * - ``storage_gb`` - Boolean / optional - ``false``; return graph, image, video, blob, and total storage in decimal GB. Details ------- When invoked without parameters, it returns general status information: * system: "ApertureDB", * status: ``0`` for a successful status request, * info: general information "OK", * version: the running server version string. The example values are illustrative and vary by server. For example, .. TESTED_EXAMPLE: GetStatus_1 .. code-block:: json [{ "GetStatus": { } }] Successful response: .. TESTED_EXAMPLE: GetStatus_1_response .. code-block:: json [{ "GetStatus": { "info": "OK", "status": 0, "system": "ApertureDB", "version": "0.19.15.0" } }] Response and errors ------------------- Every successful response includes ``system``, ``status``, ``info``, and ``version``. Requested measurements are additional fields. Use :doc:`GetMetrics` for monitoring. Invalid parameter types or an unauthenticated request return ``status: -1``. Check the error envelope and ``info`` as described in :doc:`../Responses`; a connection or TLS failure can prevent a JSON response entirely. Examples -------- The following shows how to obtain all status information: .. TESTED_EXAMPLE: GetStatus_2 .. code-block:: json [{ "GetStatus": { "all": true } }] Successful response: .. TESTED_EXAMPLE: GetStatus_2_response .. code-block:: json [{ "GetStatus": { "connection_count": 1, "info": "OK", "memory_utilization": 0.09, "memory_utilization_gb": 3, "queries_running": 1, "status": 0, "storage_gb": { "blobs": 0.01, "graph": 0.0, "images": 0.01, "total": 0.07, "videos": 0.05 }, "system": "ApertureDB", "version": "0.19.15.0", "queries_queued": 0 } }]