GetStatus
Retrieve information and status about the system.
Parameters
- [optional] all: Same as setting each parameter to True.
- [optional] connection_count: The number of open connections.
- [optional] memory_utilization: Physical memory used. Expressed as a fraction.
- [optional] memory_utilization_gb: Physical memory used, in GB.
- [optional] queries_running: The number of queries currently running.
- [optional] queries_queued: The number of queued queries.
Details
When invoked without parameters, it returns general status information:
- system: "ApertureDB",
- status: 0(ok), -1(not ready),
- info: general information "OK",
- version: "0.15.1",
For example,
[{
"GetStatus": {
}
}]
Successful response:
[{
"GetStatus": {
"info": "OK",
"status": 0,
"system": "ApertureDB",
"version": "0.15.1"
}
}]
Examples
The following shows how to obtain all status information:
[{
"GetStatus": {
"all": true
}
}]
Successful response:
[{
"GetStatus": {
"connection_count": 1,
"info": "OK",
"memory_utilization": 0.09,
"memory_utilization_gb": 3,
"queries_running": 1,
"status": 0,
"system": "ApertureDB",
"version": "0.15.1",
"queries_queued": 0
}
}]