/store

  • GET /api/v1/store

  • PUT /api/v1/store?cmd=

  • GET /api/v1/store/status

  • GET /api/v1/store/detailsStatus

GET /api/v1/store

Retrieve the information for the current store.

Example request:

curl -X GET "http://localhost:4000/api/v1/store" -H "accept: application/json"

GET /api/v1/store HTTP/1.1
Host: localhost:4000
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "status": "Active",
  "numHosts": 1,
  "numObjs": 0,
  "numPart": 0,
  "objMem": 0,
  "readRate": 0,
  "updateRate": 0,
  "createRate": 0,
  "deleteRate": 0,
  "numTimedObjs": 0,
  "numUntimedObjs": 3,
  "maxTimeout": 2,
  "postRate": 0,
  "smiRate": 0,
  "geosLocalName": "NULL"
}
Response Headers

  • Content-Type – application/json

Status Codes
Response JSON Object

  • status (string) – Current store status (Active, Not Ready, Inactive, Unknown)

  • numHosts (integer) – Current number of hosts

  • numObjs (integer) – Current number of objects

  • numPart (integer) – Current number of partitions

  • objMem (integer) – Current total memory used for objects (in bytes)

  • readRate (integer) – Number of read operations per second

  • updateRate (integer) – Number of update operations per second

  • createRate (integer) – Number of create operations per second

  • deleteRate (integer) – Number of delete operations per second

  • numTimedObjs (integer) – Number of timed objects

  • numUntimedObjs (integer) – Number of un-timed objects

  • maxTimeout (integer) – Maximum timeout for timed objects

  • postRate (integer) – Event posts per second

  • smiRate (integer) – SMI Requests per second

  • geosLocalName (string) – Local store name for GeoServer

PUT /api/v1/store?cmd=

Execute a command on the current store.

Example request:

curl -X PUT "http://localhost:4000/api/v1/store?cmd=joinall" -H "accept: application/json"

PUT /api/v1/store?cmd=joinall HTTP/1.1
Host: localhost:4000
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 OK
Vary: Accept
Content-Type: application/json
Response Headers

  • Content-Type – application/json

Query Parameters

  • cmd – the command you want to run on the store: one of joinall, leaveall, restartall, test, clear

Status Codes
Response JSON Object

  • code (string) – Error code

  • subcode (string) – Error subcode

  • message (string) – Description of the error

GET /api/v1/store/status

Get a stream of events from the server about the store status

Example request:

curl -X GET "http://localhost:4000/api/v1/store/status" -H "accept: application/json"

GET /api/v1/store/status HTTP/1.1
Host: localhost:4000
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/event-stream

id: 22519
event: message
data: {
  "utcMS":1592255364050,
  "timeTakenMS":0,
  "id":22519,
  "store":{
      "status":"Active",
      "numHosts":1,
      "numObjs":0,
      "numPart":0,
      "objMem":0,
      "readRate":0,
      "updateRate":0,
      "createRate":0,
      "deleteRate":0,
      "numTimedObjs":0,
      "numUntimedObjs":4,
      "maxTimeout":61,
      "postRate":0,
      "smiRate":0,
      "geosLocalName":"NULL"
   },
   "storeError":null,
   "hosts":[
      {
          "netInterface":"10.0.0.0",
          "subnetMask":"255.255.255.0",
          "multicastIP":"224.0.0.17",
          "useMulticast":true,
          "interconnectPort":722,
          "serverPort":721,
          "managementPort":720,
          "sslServerPort":724,
          "sslManagementPort":723,
          "licenseKey":"XXXXXXXXXXXXXXXX",
          "acceptSSL":false,
          "queryIndexMode":2,
          "useAutoNPF":true,
          "gatewayIP":"255.255.255.255",
          "netPerfFactor":10,
          "autoJoin":false,
          "startupDelay":5,
          "peerIPs":["10.0.0.175"],
          "localStoreName":"NULL",
          "hostId":"10.0.0.175",
          "status":"Active",
          "isLocal":true,
          "apiEnabled":true,
          "maxLicensedSUL":64,
          "maxRemoteClients":64,
          "maintenanceDate":null,
          "keyDate":1593500400000,
          "licensedVer":"5.0",
          "licensedGeos":"Full",
          "licensedHServer":false,
          "maxLicensedHostCount":64,
          "maxReplicas":1,
          "gridComputingEnabled":2,
          "maxStoreMemoryMB":100,
          "localSULsConsumed":1,
          "networkInterfaces":["10.0.0.0","10.4.0.0","172.12.82.0"],
          "numObjs":0,
          "objMem":0,
          "createRate":0,
          "readRate":0,
          "updateRate":0,
          "deleteRate":0,
          "numTimedObjs":0,
          "numUntimedObjs":4,
          "maxTimeout":61,
          "serverVer":"5.8.18.349",
          "maxMemory":0,
          "maxServerCache":0,
          "compatVer":202,
          "mgtPackEnabled":true,
          "maxEventTries":1,
          "lruThreshold":100,
          "replThreshold":60,
          "maxClientCacheKB":100000,
          "eventHandlerIP":"0.0.0.0",
          "keyPairTime":1453017600000,
          "numSULsInUse":1
      }
    ],
  "hostsError":[null],
  "remoteStores":[],
  "remoteStoresError":null
}
Response Headers

  • Content-Type – text/event-stream

Status Codes
GET /api/v1/store/detailsStatus

Get a stream of events from the server about the store status

Example request:

curl -X GET "http://localhost:4000/api/v1/store/detailsStatus" -H "accept: application/json"

GET /api/v1/store/detailsStatus HTTP/1.1
Host: localhost:4000
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/event-stream

id: 1
event: message
data: {
  "utcMS": 1592257071848,
  "timeTakenMS": 0,
  "id": 1,
  "heatMap": {
      "status": [
          1,
          1,
          1,
          ...
          1
      ],
      "host": [
          "10.0.0.175",
          "10.0.0.175",
          "10.0.0.175",
          ...
          "10.0.0.175"
      ]
  },
  "heatMapError": null,
  "heatMapTimeMS": 0,
  "remoteClients": [],
  "remoteClientsError": null,
  "remoteClientsTimeMS": 0,
  "backupRestore": {
      "inProgress": false,
      "isMineInProgress": false,
      "isMineCompleted": false,
      "numFileSuccessful": 0,
      "numUserObjsSuccessful": 0,
      "numNameObjsSuccessful": 0,
      "numDependObjsSuccessful": 0,
      "numUserObjsSkipped": 0,
      "numNameObjsSkipped": 0,
      "numDependObjsSkipped": 0,
      "status": "OK",
      "statusCode": 0,
      "numFilesFailed": 0,
      "numObjsSuccessful": 0,
      "numObjsFailed": 0,
      "numObjsSkipped": 0,
      "dirPath": "",
      "fileID": "",
      "isBackup": false,
      "hostID": "0.0.0.0",
      "appID": 0,
      "useMaxFileLen": false,
      "maxFileLen": 0,
      "overwrite": false,
      "history": []
  },
  "backupRestoreError": null,
  "backupRestoreTimeMS": 0
}
Response Headers

  • Content-Type – text/event-stream

Status Codes