Response

Edit online
Parameters
Table 1. Response parameters for Device API status servlet method
Parameter Style Type Description
X-Status-Version header String

Current version of the interface.

Required: Yes
X-Status-Health header String

A value from 0 - 9 that represents how many of the total allowable connections are currently being utilized.

Required: Yes
X-Status-Online header String

Specifies whether the dsnet-core application on the Accessor is running (true) or not (false).

When the advanced configuration parameter "service.http.status.roll-up-status" is true, this value may be false when a configured threshold is exceeded.

Required: Yes
health body String

Response body representation of the response header value for X-Status-Health.

Required: Yes
online body Boolean

Response body representation of the response header value for X-Status-Online.

Required: Yes
write_permits body Map Map including "current", "max", and "is_over_threshold" for write permits
read_permits body Map Map including "current", "max", and "is_over_threshold" for read permits
query_permits body Map Map including "current", "max", and "is_over_threshold" for query permits
on_heap_permits body Map Map including "current", "max", and "is_over_threshold" for on-heap permits
off_heap_permits body Map Map including "current", "max", and "is_over_threshold" for off-heap permits
HTTP request is successful response
Request  

 GET 10.132.11.153:8337/status

Response 

HTTP/1.1 200 OK

Date: Mon, 13 Feb 2017 19:41:22 GMT

X-Status-Version: 3.0

X-Status-Health: 0

X-Status-Online: true

Content-Length: 35

Server: Jetty(9.2.10.v20150310)

{

  "health": 0,

  "online": true

  "write_permits": {
    "current": "0",
    "max": "98",
    "is_over_threshold": false
  },
  "read_permits": {
    "current": "0",
    "max": "98",
    "is_over_threshold": false
  },
  "query_permits": {
    "current": "0",
    "max": "98",
    "is_over_threshold": false
   },
   "on_heap_permits": {
    "current": "52245298",
    "max": "286418534",
    "is_over_threshold": false
  },
  "off_heap_permits": {
    "current": "131072000",
    "max": "524288000",
    "is_over_threshold": false
  }

}