Gets the health check reports ordered by CheckUpDate descending.
name | type | description | default | constraints |
---|---|---|---|---|
endDate | query | End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. | 0 | |
limit | query | Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. | 31 | required |
offset | query | Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. | 0 | required |
startDate | query | Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. | 0 |
media type | data type | description |
---|---|---|
application/json | HealthCheckReportsResult (JSON) | HealthCheckReportsResult |
application/xml | healthCheckReportsResult (XML) |
GET /healthMonitors
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"healthCheckReport" : [ {
"id" : 12345,
"checkUpDay" : 12345,
"mqttStatus" : 12345,
"restApiStatus" : 12345,
"dataStoreStatus" : 12345,
"rulesEngineStatus" : 12345,
"slaPercent" : 12345.0,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345
}, {
"id" : 12345,
"checkUpDay" : 12345,
"mqttStatus" : 12345,
"restApiStatus" : 12345,
"dataStoreStatus" : 12345,
"rulesEngineStatus" : 12345,
"slaPercent" : 12345.0,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345
} ],
"limitExceeded" : true
}
Gets an aggregate health check report for the given period.
name | type | description | default |
---|---|---|---|
endDate | query | End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. | 0 |
startDate | query | Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. | 0 |
media type | data type | description |
---|---|---|
application/json | HealthCheckPeriodReport (JSON) | HealthCheckPeriodReport |
application/xml | healthCheckPeriodReport (XML) |
GET /healthMonitors/period
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"totalRows" : 12345,
"mqttStatus" : 12345,
"restApiStatus" : 12345,
"dataStoreStatus" : 12345,
"rulesEngineStatus" : 12345,
"slaPercent" : 12345.0,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345
}
Finds Health Check Report by the given path parameter.
name | type | description | constraints |
---|---|---|---|
healthCheckReportId | path | required |
media type | data type | description |
---|---|---|
application/json | HealthCheckReport (JSON) | HealthCheckReport |
application/xml | healthCheckReport (XML) |
GET /healthMonitors/{healthCheckReportId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"id" : 12345,
"checkUpDay" : 12345,
"mqttStatus" : 12345,
"restApiStatus" : 12345,
"dataStoreStatus" : 12345,
"rulesEngineStatus" : 12345,
"slaPercent" : 12345.0,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345
}
Gets all health check logs related to a health check report.
name | type | description | default | constraints |
---|---|---|---|---|
healthCheckReportId | path | the health check report for which ask logs | required | |
endDate | query | End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. | 0 | |
fetchLogs | query | Sets whether or not retrieve also text log for a Health Check Report, default to false. | false | required |
startDate | query | Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. | 0 |
media type | data type | description |
---|---|---|
application/json | HealthCheckLogsResult (JSON) | HealthCheckLogsResult |
application/xml | healthCheckLogsResult (XML) |
GET /healthMonitors/{healthCheckReportId}/healthCheckLogs
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"healthCheckLog" : [ {
"id" : 12345,
"healthCheckReportId" : 12345,
"checkUpTime" : 12345,
"startedOn" : 12345,
"endedOn" : 12345,
"mqttStatus" : true,
"restApiStatus" : true,
"dataStoreStatus" : true,
"rulesEngineStatus" : true,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345,
"log" : "..."
}, {
"id" : 12345,
"healthCheckReportId" : 12345,
"checkUpTime" : 12345,
"startedOn" : 12345,
"endedOn" : 12345,
"mqttStatus" : true,
"restApiStatus" : true,
"dataStoreStatus" : true,
"rulesEngineStatus" : true,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345,
"log" : "..."
} ],
"limitExceeded" : true
}
Gets a specific HealthCheckLog by the given parameters
name | type | description | constraints |
---|---|---|---|
healthCheckLogId | path | the HealthCheckLog ID. | required |
healthCheckReportId | path | the HealthCheckReport ID. | required |
media type | data type | description |
---|---|---|
application/json | HealthCheckLog (JSON) | HealthCheckLog |
application/xml | healthCheckLog (XML) |
GET /healthMonitors/{healthCheckReportId}/healthCheckLogs/{healthCheckLogId}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"id" : 12345,
"healthCheckReportId" : 12345,
"checkUpTime" : 12345,
"startedOn" : 12345,
"endedOn" : 12345,
"mqttStatus" : true,
"restApiStatus" : true,
"dataStoreStatus" : true,
"rulesEngineStatus" : true,
"mqttResponseTime" : 12345,
"restResponseTime" : 12345,
"restComResponseTime" : 12345,
"log" : "..."
}