System Information REST Endpoints

the {{ocienthyperscaledatawarehouse}} 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 docid\ jtynlpc rgdksxytttfyh { "tab" "examples", "url" "http //oc1 lts0 9090/v1/stats", "name" "get statistics", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "filter", "type" "string", "description" "filter for the statistics " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "shm4ez6m3ddx41exw 17t", "code" "\[{\n \\"name\\" \\"vm stats pdfcachesize\\",\n \\"time\\" \\"1686335017884363\\",\n \\"timestamp\\" \\"2023 06 09t18 23 37 884z\\",\n \\"node\\" \\"sql0\\",\n \\"value\\" 4680936\n},\n{\n \\"name\\" \\"localstorageservice device spacefree\\",\n \\"time\\" \\"1686335145388588\\",\n \\"timestamp\\" \\"2023 06 09t18 25 45 388z\\",\n \\"node\\" \\"sql0\\",\n \\"value\\" 0,\n \\"device\\" \\"4418fbc3 fcf9 5cfe b2b3 b41a8247a600\\"\n }\n]", "language" "200", "customlabel" "" } ], "selectedlanguageid" "shm4ez6m3ddx41exw 17t" }, "examples" { "languages" \[ { "id" "jiyzr0ynolbqcsuzmzspv", "code" "curl location request get 'http //oc1 lts0 9090/v1/stats' \\\\\n header 'accept application/json' ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "jiyzr0ynolbqcsuzmzspv" }, "description" "retrieve the statistics on each node in the database ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false } 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 { "tab" "examples", "url" "http //oc1 lts0 9090/v1/version", "name" "get version", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "mk gl2s5goafnvefjmvll", "code" "{\n \\"version\\" \\"24 0 0\\",\n \\"timestamp\\" \\"20231110 212417\\",\n \\"git commit\\" \\"178ba7a7549bd40c137035c5cd4f10c55fd31b00\\",\n \\"build user\\" \\"\\",\n \\"build type\\" \\"debug\\",\n \\"build flags\\" \\"fb,lld flags,mcmodel medium,tls model initial exec\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "mk gl2s5goafnvefjmvll" }, "examples" { "languages" \[ { "id" "r 2plzkyatsv50bclgcc1", "code" "curl location request get 'http //oc1 lts0 9090/v1/version' \\\\\n header 'accept application/json'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "r 2plzkyatsv50bclgcc1" }, "description" "retrieve the version of the software running ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "http //oc1 lts0 9090/v1/status", "name" "get status", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "yucwqbiawcsqxijrvupzm", "code" "active", "language" "200", "customlabel" "" } ], "selectedlanguageid" "yucwqbiawcsqxijrvupzm" }, "examples" { "languages" \[ { "id" "td6bpv8whi evhax ous7", "code" "curl location request get 'http //oc1 lts0 9090/v1/status' \\\\\n header 'accept application/json'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "td6bpv8whi evhax ous7" }, "description" "retrieve the status of the software running ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "http //oc1 lts0 9090/v1/sysconfig", "name" "get configuration", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "4xrkafofiqq9q5xekwnq8", "code" "{\n \\"system name\\" \\"abc7d45f 1e9c 4210 811d ffg6dbd82297\\",\n \\"node name\\" \\"sql0\\",\n \\"node uuid\\" \\"578c11a2 1996 523f a371 c393b4e5ff2e\\",\n \\"hostname\\" \\"username dev0\\",\n \\"roles\\" \[\n \\"administration\\",\n \\"health\\",\n \\"vm\\",\n \\"cmdcomp\\"\n ],\n \\"failed roles\\" \[],\n \\"endpoints\\" \[\n {\n \\"name\\" \\"adminopenendpoint\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 19000\n },\n {\n \\"name\\" \\"restendpoint\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 8000\n },\n {\n \\"name\\" \\"adminsecureendpoint\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 18500\n },\n {\n \\"name\\" \\"dataendpoint\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 16500\n },\n {\n \\"name\\" \\"sqlexternal\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 3070\n }\n ],\n \\"totalram\\" 450948103168,\n \\"processors\\" 120,\n \\"hugepages\\" \[\n {\n \\"size\\" 1257152,\n \\"total\\" 0,\n \\"free\\" 0,\n \\"reserved\\" 0\n },\n {\n \\"size\\" 1060041824,\n \\"total\\" 0,\n \\"free\\" 0,\n \\"reserved\\" 0\n }\n ],\n \\"storage devices\\" \[\n {\n \\"id\\" \\"4425fad3 fcf9 5cfd f3b3 b47a8457a300\\",\n \\"address\\" \\"/address/4425fad3 fcf9 5cfd f3b3 b47a8457a300 dat\\",\n \\"type\\" \\"sata\\",\n \\"use\\" \\"payload\\",\n \\"pci address\\" \\"\\",\n \\"mount point\\" \\"\\",\n \\"device path\\" \\"\\"\n },\n {\n \\"id\\" \\"9ae82aa7 ab73 5g86 bb34 13b27945c701\\",\n \\"address\\" \\"/address/9ae82aa7 ab73 5g86 bb34 13b27945c701 dat\\",\n \\"type\\" \\"sata\\",\n \\"use\\" \\"payload\\",\n \\"pci address\\" \\"\\",\n \\"mount point\\" \\"\\",\n \\"device path\\" \\"\\"\n }\n ],\n \\"connections\\" \[\n {\n \\"address\\" \\"111 1 1 1\\",\n \\"remote port\\" 45598,\n \\"state\\" \\"connected\\",\n \\"locally initiated\\" false\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "4xrkafofiqq9q5xekwnq8" }, "examples" { "languages" \[ { "id" "lwlih1bxfskjklfub7yfo", "code" "curl location request get 'http //oc1 lts0 9090/v1/sysconfig' \\\\\n header 'accept application/json'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "lwlih1bxfskjklfub7yfo" }, "description" "retrieve the configuration about this node in json format ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "http //oc1 lts0 9090/v1/dbconfig", "name" "get configuration of whole system", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "tyrqbdbsctuz2rlpdccne", "code" "{\n \\"system name\\" \\"abc7d45f 1e9c 4210 811d ffg6dbd82297\\",\n \\"node name\\" \\"sql0\\",\n \\"node uuid\\" \\"578c11a2 1996 523f a371 c393b4e5ff2e\\",\n \\"hostname\\" \\"username dev0\\",\n \\"roles\\" \[\n \\"administration\\",\n \\"health\\",\n \\"vm\\",\n \\"cmdcomp\\"\n ],\n \\"failed roles\\" \[],\n \\"endpoints\\" \[\n {\n \\"name\\" \\"adminopenendpoint\\",\n \\"type\\" \\"full\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 18000\n },\n {\n \\"name\\" \\"restendpoint\\",\n \\"type\\" \\"full\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 8000\n },\n {\n \\"name\\" \\"adminsecureendpoint\\",\n \\"type\\" \\"full\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 18500\n },\n {\n \\"name\\" \\"dataendpoint\\",\n \\"type\\" \\"full\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 16500\n },\n {\n \\"name\\" \\"sqlexternal\\",\n \\"type\\" \\"full\\",\n \\"address\\" \\"localhost\\",\n \\"port\\" 3070\n }\n ],\n \\"totalram\\" 450948103168,\n \\"processors\\" 120,\n \\"hugepages\\" \[\n {\n \\"size\\" 1257152,\n \\"total\\" 0,\n \\"free\\" 0,\n \\"reserved\\" 0\n },\n {\n \\"size\\" 1060041824,\n \\"total\\" 0,\n \\"free\\" 0,\n \\"reserved\\" 0\n }\n ],\n \\"storage devices\\" \[\n {\n \\"id\\" \\"4425fad3 fcf9 5cfd f3b3 b47a8457a300\\",\n \\"address\\" \\"/address/4425fad3 fcf9 5cfd f3b3 b47a8457a300 dat\\",\n \\"type\\" \\"sata\\",\n \\"use\\" \\"payload\\",\n \\"pci address\\" \\"\\",\n \\"mount point\\" \\"\\",\n \\"device path\\" \\"\\"\n },\n {\n \\"id\\" \\"9ae82aa7 ab73 5g86 bb34 13b27945c701\\",\n \\"address\\" \\"/address/9ae82aa7 ab73 5g86 bb34 13b27945c701 dat\\",\n \\"type\\" \\"sata\\",\n \\"use\\" \\"payload\\",\n \\"pci address\\" \\"\\",\n \\"mount point\\" \\"\\",\n \\"device path\\" \\"\\"\n }\n ],\n \\"connections\\" \[\n {\n \\"address\\" \\"111 1 1 1\\",\n \\"remote port\\" 45598,\n \\"state\\" \\"connected\\",\n \\"locally initiated\\" false\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "tyrqbdbsctuz2rlpdccne" }, "examples" { "languages" \[ { "id" "63gjxjbm6nkga05sqyv4i", "code" "curl location request get 'http //oc1 lts0 9090/v1/dbconfig' \\\\\n header 'accept application/json' \\\\\n data raw '{\\"filter\\" \\"string\\"}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "63gjxjbm6nkga05sqyv4i" }, "description" "retrieve the configuration of the system as a whole in json format ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "http //oc1 lts0 9090/v1/config", "name" "get configuration parameters", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "nay5vtv7iibfei9uuotob", "code" "{\n \\"silotype\\" \\"xg runtime physicalsiloset t\\",\n \\"tlbfsinfo enabled\\" \\"false\\",\n \\"tlbfsinfo mountpoint\\" \\"/mnt/name/hugepages1g\\",\n \\"tlbfsinfo hugepagesize\\" \\"1073741824\\",\n \\"tlbfsinfo hugepagecount\\" \\"512\\",\n \\"memory warninghpmemoryusageratio\\" \\"0 80000000000000004\\",\n \\"memory preferredhpmemoryusageratio\\" \\"0 94999999999999996\\",\n \\"memory warningheapmemoryusageratio\\" \\"0 90000000000000002\\",\n \\"silos numsilos\\" \\"2\\",\n \\"silos coresets computecoremask\\" \\"0b111111111111000\\",\n \\"silos coresets iocoremask\\" \\"0b1000000111100000\\",\n \\"silos coresets networkcoremask\\" \\"0b10000000000111100\\",\n \\"silos coresets generalcoremask\\" \\"0b100000000000000111\\",\n \\"gdsclientparameters t batchtimer\\" \\"150000000n\\",\n \\"gdsclientparameters t maxbatchcount\\" \\"4096\\",\n \\"ports adminsecure\\" \\"18500\\",\n \\"ports data\\" \\"16500\\",\n \\"ports hsi\\" \\"16900\\",\n \\"ports ingress\\" \\"15300\\",\n \\"ports rest\\" \\"8000\\",\n \\"ports sql\\" \\"3070\\",\n \\"ports adminopen\\" \\"18000\\"\n \\"operatorvm vmprotocolparameters vmclusterraftfileparameters filename\\" \\"sql0 vmcluster raft\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "nay5vtv7iibfei9uuotob" }, "examples" { "languages" \[ { "id" "f0trc2c fc flvcjxjnqb", "code" "curl location request get 'http //oc1 lts0 9090/v1/config' \\\\\n header 'accept application/json'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "f0trc2c fc flvcjxjnqb" }, "description" "retrieve values of configuration parameters ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }