Session Resource

A session consists of a client connection, any number of related backend connections, a router module session and possibly filter module sessions. Each session is created on a service and a service can have multiple sessions.

Resource Operations

Get a session

Get a single session. :id must be a valid session ID.

GET /sessions/:id

Response

Status: 200 OK

{
    "id": 1,
    "state": "Session ready for routing",
    "user": "jdoe",
    "address": "192.168.0.200",
    "service": "/services/my-service",
    "connected": "Wed Aug 31 03:03:12 2016",
    "idle": 260
}

Supported Request Parameter

  • fields

Get all sessions

Get all sessions.

GET /sessions

Response

Status: 200 OK

[
    {
        "id": 1,
        "state": "Session ready for routing",
        "user": "jdoe",
        "address": "192.168.0.200",
        "service": "/services/My-Service",
        "connected": "Wed Aug 31 03:03:12 2016",
        "idle": 260
    },
    {
        "id": 2,
        "state": "Session ready for routing",
        "user": "dba",
        "address": "192.168.0.201",
        "service": "/services/My-Service",
        "connected": "Wed Aug 31 03:10:00 2016",
        "idle": 1
    }
]

Supported Request Parameter

  • fields
  • range

Get all connections created by a session

Get all backend connections created by a session. :id must be a valid session ID.

GET /sessions/:id/connections

Response

Status: 200 OK

[
    {
        "state": "DCB in the polling loop",
        "role": "Backend Request Handler",
        "server": "/servers/db-serv-01",
        "service": "/services/my-service",
        "statistics": {
            "reads":             2197
            "writes":            1562
            "buffered_writes":   0
            "high_water_events": 0
            "low_water_events":  0
        }
    },
    {
        "state": "DCB in the polling loop",
        "role": "Backend Request Handler",
        "server": "/servers/db-serv-02",
        "service": "/services/my-service",
        "statistics": {
            "reads":             0
            "writes":            0
            "buffered_writes":   0
            "high_water_events": 0
            "low_water_events":  0
        }
    }
]

Supported Request Parameter

  • fields
  • range

Close a session

Close a session. This will forcefully close the client connection and any backend connections.

DELETE /sessions/:id

Response

Status: 204 No Content