System Information REST Endpoints

The Ocient Hyperscale Data Warehouse™ maintains many internal statistics. You can access the statistics on each node in the database using a REST interface that listens on port 9090 by default. For an overview of monitoring statistics, see Statistics Monitoring.

Get Statistics

GET http://oc1-lts0:9090/v1/stats

Retrieve the statistics on each node in the database.

Body Parameters

Name	Type	Required	Description
`filter`	string	No	Filter for the statistics.

Example Request

curl --location --request GET 'http://oc1-lts0:9090/v1/stats' \
--header 'Accept: application/json'

Example Response

200

[{
  "name": "vm.stats.pdfCacheSize",
  "time": "1686335017884363",
  "timestamp": "2023-06-09T18:23:37.884Z",
  "node": "sql0",
  "value": 4680936
},
{
    "name": "localStorageService.device.spaceFree",
    "time": "1686335145388588",
    "timestamp": "2023-06-09T18:25:45.388Z",
    "node": "sql0",
    "value": 0,
    "device": "4418fbc3-fcf9-5cfe-b2b3-b41a8247a600"
  }
]

These fields appear in every entry returned in the response from the http://oc1-lts0:9090/v1/stats endpoint:

name
time
timestamp
node
value

Additional fields can vary.

Get Version

GET http://oc1-lts0:9090/v1/version

Retrieve the version of the software running.

Example Request

curl --location --request GET 'http://oc1-lts0:9090/v1/version' \
--header 'Accept: application/json'

Example Response

200

{
    "version": "24.0.0",
    "timestamp": "20231110.212417",
    "git_commit": "178ba7a7549bd40c137035c5cd4f10c55fd31b00",
    "build_user": "",
    "build_type": "DEBUG",
    "build_flags": "fb,lld_flags,mcmodel_medium,tls_model_initial_exec"
}

Get Status

GET http://oc1-lts0:9090/v1/status

Retrieve the status of the software running.

Example Request

curl --location --request GET 'http://oc1-lts0:9090/v1/status' \
--header 'Accept: application/json'

Example Response

200

Active

Get Configuration

GET http://oc1-lts0:9090/v1/sysconfig

Retrieve the configuration about this node in JSON format.

Example Request

curl --location --request GET 'http://oc1-lts0:9090/v1/sysconfig' \
--header 'Accept: application/json'

Example Response

200

{
  "system_name": "abc7d45f-1e9c-4210-811d-ffg6dbd82297",
  "node_name": "sql0",
  "node_uuid": "578c11a2-1996-523f-a371-c393b4e5ff2e",
  "hostname": "username-dev0",
  "roles": [
    "administration",
    "health",
    "vm",
    "cmdComp"
  ],
  "failed_roles": [],
  "endpoints": [
    {
      "name": "adminopenendpoint",
      "address": "localhost",
      "port": 19000
    },
    {
      "name": "restendpoint",
      "address": "localhost",
      "port": 8000
    },
    {
      "name": "adminsecureendpoint",
      "address": "localhost",
      "port": 18500
    },
    {
      "name": "dataendpoint",
      "address": "localhost",
      "port": 16500
    },
    {
      "name": "sqlexternal",
      "address": "localhost",
      "port": 3070
    }
  ],
  "totalram": 450948103168,
  "processors": 120,
  "hugepages": [
    {
      "size": 1257152,
      "total": 0,
      "free": 0,
      "reserved": 0
    },
    {
      "size": 1060041824,
      "total": 0,
      "free": 0,
      "reserved": 0
    }
  ],
  "storage_devices": [
    {
      "id": "4425fad3-fcf9-5cfd-f3b3-b47a8457a300",
      "address": "/address/4425fad3-fcf9-5cfd-f3b3-b47a8457a300.dat",
      "type": "SATA",
      "use": "PAYLOAD",
      "pci_address": "",
      "mount_point": "",
      "device_path": ""
    },
    {
      "id": "9ae82aa7-ab73-5g86-bb34-13b27945c701",
      "address": "/address/9ae82aa7-ab73-5g86-bb34-13b27945c701.dat",
      "type": "SATA",
      "use": "PAYLOAD",
      "pci_address": "",
      "mount_point": "",
      "device_path": ""
    }
  ],
  "connections": [
    {
      "address": "111.1.1.1",
      "remote_port": 45598,
      "state": "connected",
      "locally_initiated": false
    }
  ]
}

Get Configuration of Whole System

GET http://oc1-lts0:9090/v1/dbconfig

Retrieve the configuration of the system as a whole in JSON format.

Example Request

curl --location --request GET 'http://oc1-lts0:9090/v1/dbconfig' \
--header 'Accept: application/json' \
--data-raw '{"filter":"string"}'

Example Response

200

{
  "system_name": "abc7d45f-1e9c-4210-811d-ffg6dbd82297",
  "node_name": "sql0",
  "node_uuid": "578c11a2-1996-523f-a371-c393b4e5ff2e",
  "hostname": "username-dev0",
  "roles": [
    "administration",
    "health",
    "vm",
    "cmdComp"
  ],
  "failed_roles": [],
  "endpoints": [
    {
          "name": "adminopenendpoint",
          "type": "FULL",
          "address": "localhost",
          "port": 18000
    },
    {
      "name": "restendpoint",
      "type": "FULL",
      "address": "localhost",
      "port": 8000
    },
    {
      "name": "adminsecureendpoint",
      "type": "FULL",
      "address": "localhost",
      "port": 18500
    },
    {
      "name": "dataendpoint",
      "type": "FULL",
      "address": "localhost",
      "port": 16500
    },
    {
      "name": "sqlexternal",
      "type": "FULL",
      "address": "localhost",
      "port": 3070
    }
  ],
  "totalram": 450948103168,
  "processors": 120,
  "hugepages": [
    {
      "size": 1257152,
      "total": 0,
      "free": 0,
      "reserved": 0
    },
    {
      "size": 1060041824,
      "total": 0,
      "free": 0,
      "reserved": 0
    }
  ],
  "storage_devices": [
    {
      "id": "4425fad3-fcf9-5cfd-f3b3-b47a8457a300",
      "address": "/address/4425fad3-fcf9-5cfd-f3b3-b47a8457a300.dat",
      "type": "SATA",
      "use": "PAYLOAD",
      "pci_address": "",
      "mount_point": "",
      "device_path": ""
    },
    {
      "id": "9ae82aa7-ab73-5g86-bb34-13b27945c701",
      "address": "/address/9ae82aa7-ab73-5g86-bb34-13b27945c701.dat",
      "type": "SATA",
      "use": "PAYLOAD",
      "pci_address": "",
      "mount_point": "",
      "device_path": ""
    }
  ],
  "connections": [
    {
      "address": "111.1.1.1",
      "remote_port": 45598,
      "state": "connected",
      "locally_initiated": false
    }
  ]
}

Get Configuration Parameters

GET http://oc1-lts0:9090/v1/config

Retrieve values of configuration parameters.

Example Request

curl --location --request GET 'http://oc1-lts0:9090/v1/config' \
--header 'Accept: application/json'

Example Response

200

{
  "siloType": "xg::runtime::physicalSiloSet_t",
  "tlbfsInfo.enabled": "false",
  "tlbfsInfo.mountPoint": "/mnt/name/hugepages1G",
  "tlbfsInfo.hugePageSize": "1073741824",
  "tlbfsInfo.hugePageCount": "512",
  "memory.warningHpMemoryUsageRatio": "0.80000000000000004",
  "memory.preferredHpMemoryUsageRatio": "0.94999999999999996",
  "memory.warningHeapMemoryUsageRatio": "0.90000000000000002",
  "silos.numSilos": "2",
  "silos.coreSets.computeCoreMask": "0b111111111111000",
  "silos.coreSets.ioCoreMask": "0b1000000111100000",
  "silos.coreSets.networkCoreMask": "0b10000000000111100",
  "silos.coreSets.generalCoreMask": "0b100000000000000111",
  "gdsClientParameters_t.batchTimer": "150000000n",
  "gdsClientParameters_t.maxBatchCount": "4096",
  "ports.adminsecure": "18500",
  "ports.data": "16500",
  "ports.hsi": "16900",
  "ports.ingress": "15300",
  "ports.rest": "8000",
  "ports.sql": "3070",
  "ports.adminopen": "18000"
  "operatorvm.vmProtocolParameters.vmClusterRaftFileParameters.fileName": "sql0-vmCluster.raft"
}