Sign in
connections

close the connections to the cluster

delete/connections/{clusterId}

Path parameters

clusterIdstring required

Id or name of the cluster

Query parameters

type'disconnect' | 'shutdown_read' | 'shutdown_write'

The way to close the connection.

  • disconnect - Simply disconnects the connection.
  • shutdown_read - Prevents the socket from being able to read any inbound data. Good for testing things like heartbeat failures.
  • shutdown_write - Prevents the socket from being able to write any outbound data. This will typically close the connection so does not have much use over disconnect.

Defaults to disconnect.

Response

closed connections

idinteger required
data_centersDataCenterConnectionReport[] required— unresolved $ref

Example response

{
  "id": "0",
  "data_centers": [
    {
      "id": "0",
      "nodes": [
        {
          "id": "0",
          "connections": [
            "127.0.0.1:38850",
            "127.0.0.1:38852"
          ],
          "address": "127.0.0.1:38472"
        },
        {
          "id": "1",
          "connections": [
            "127.0.0.1:38472"
          ],
          "address": "127.0.0.2:38472"
        },
        {
          "id": "2",
          "connections": [
            "127.0.0.1:54282"
          ],
          "address": "127.0.0.3:38472"
        }
      ]
    },
    {
      "id": "1",
      "nodes": [
        {
          "id": "0",
          "connections": [
            "127.0.0.1:18432"
          ],
          "address": "127.0.1.1:9042"
        },
        {
          "id": "1",
          "connections": [
            "127.0.0.1:7426"
          ],
          "address": "127.0.1.2:9042"
        }
      ]
    }
  ]
}

Changes