skip to main content
Corticon Server: Integration & Deployment Guide : Corticon API reference : REST Management API : Summary of REST methods for management of Decision Services : API Get Server Info
 

Try Corticon Now
API Get Server Info
<base>/server/info
HTTP GET
Returns information about the server. The returned object contains information about both the server and the Decision Services deployed on that server. Both the server and Decision Services have a window and a general section. Both sections provide information on their metrics. Both the window and general fields are an array of objects, and each object consists of a type and a name -- these correspond to the type and name of a metrics value returned in the Metrics REST API call. For more information about the type field, refer to the Metric Types section. The objects representing the metrics are shown here in the order they would show in the metrics call. The resulting payload is enclosed in the response's body in JSON object form. The JSON object structure is as follows:
{
"metricTypes": {
"decisionService": {
"window": [
{
"name": <Name of the general info field>,
"type": <Field's type as a description, (see Metric Types)>,
"dataType" : <Field's storage type, what type it should be stored as>,
"aggregateTypes" : [ <Array of aggregations that can be done on this datatype,
this can be AVERAGE, MIN, MAX, or TOTAL>
},
...
],
"general": [
{
"name": <Name of the general info field>,
"type": <Field's type as a description, (see Metric Types)>,
"dataType" : <Field's storage type, what type it should be stored as>,
"aggregateTypes" : [ <Array of aggregations that can be done on this datatype,
this can be AVERAGE, MIN, MAX, or TOTAL>
},
...
]
},
"server": {
"window": [
{
"name": <Name of the general info field>,
"type": <Field's type as a description, (see Metric Types)>,
"dataType" : <Field's storage type, what type it should be stored as>,
"aggregateTypes" : [ <Array of aggregations that can be done on this datatype,
this can be AVERAGE, MIN, MAX, or TOTAL>
},
...
],
"general": [
{
"name": <Name of the general info field>,
"type": <Field's type as a description, (see Metric Types)>,
"dataType" : <Field's storage type, what type it should be stored as>,
"aggregateTypes" : [ <Array of aggregations that can be done on this datatype,
this can be AVERAGE, MIN, MAX, or TOTAL>
},
...
]
}
},
"windowSize": <The size, in milliseconds, of each interval window>
}
An example of a response is:
{
"metricTypes": {
"decisionService": {
"window": [
{
"name": "totalIntervalExecutionTime",
"type": "milliseconds"
},
{
"name": "totalIntervalNumberOfExecutions",
"type": "count"
}
],
"general": [
{
"name": "totalExecutionTime",
"type": "milliseconds"
},
{
"name": "totalNumberOfExecutions",
"type": "count"
}
]
},
"server": {
"window": [
{
"name": "memoryUsage",
"type": "bytes"
},
{
"name": "totalIntervalExecutionTime",
"type": "milliseconds"
},
{
"name": "totalIntervalNumberOfExecutions",
"type": "count"
}
],
"general": [
{
"name": "totalExecutionTime",
"type": "milliseconds"
},
{
"name": "totalNumberOfExecutions",
"type": "count"
}
]
}
},
"windowSize": 10000
}
Success status codes:
*200 OK
Error status codes:
*500 Internal Server Error