IBM DataPower Operations Dashboard v1.0.6.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Alert Query REST API

User will need an opDashOperatorRole access for this API

Run alert by reference:

GET /op/api/v1/alerts/00000000-0000-0000-0000-a10000000001

{
"message": "Execution finished with no alerts.",
"esSearchResponse": {
"hits": {
"total": 0,
"hits": [],
"max_score": 0
},
"_shards": {
"total": 15,
"failed": 0,
"successful": 15
},
"timed_out": false,
"took": 236,
"aggregations": {
"terms1": {
"sum_other_doc_count": 0,
"buckets": [],
"doc_count_error_upper_bound": 0
}
}
},
"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},\"filter\":{\"bool\":{\"must\":[{\"range\":{\"systemLoadTimeInMil\":{\"gte\":1486024160406,\"lte\":1486027760406}}}],\"must_not\":[]}}}},\"aggs\":{\"terms1\":{\"terms\":{\"field\":\"deviceName\",\"size\":1000,\"shardSize\":10000,\"order\":{\"max\":\"desc\"}},\"aggs\":{\"max\":{\"max\":{\"field\":\"usedCPUInPercentage\"}}}}},\"size\":0}",
"status": "OK",
"recipients": "someone@my-org.com",
"apiReference": "00000000-0000-0000-0000-a10000000001",
"queryName": "Devices_CPU",
"queryId": 1,
"filters": ":timeRangeType-recent:timeRangePeriod-3600000",
"threshold": 0
}

error:

{
"summary": "Exception:Reference test not found in QueryMetadata table (org.montier.alerts.rest.QueryResource.executeQuery(QueryResource.java:58))",
"message": "Reference test not found in QueryMetadata table",
"status": "error"
}


Run alert by internal ID number:

GET /op/api/v1/alerts/byId/1

{
"message": "Execution finished with no alerts.",
"esSearchResponse": {
"hits": {
"total": 0,
"hits": [],
"max_score": 0
},
"_shards": {
"total": 15,
"failed": 0,
"successful": 15
},
"timed_out": false,
"took": 236,
"aggregations": {
"terms1": {
"sum_other_doc_count": 0,
"buckets": [],
"doc_count_error_upper_bound": 0
}
}
},
"jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},\"filter\":{\"bool\":{\"must\":[{\"range\":{\"systemLoadTimeInMil\":{\"gte\":1486024160406,\"lte\":1486027760406}}}],\"must_not\":[]}}}},\"aggs\":{\"terms1\":{\"terms\":{\"field\":\"deviceName\",\"size\":1000,\"shardSize\":10000,\"order\":{\"max\":\"desc\"}},\"aggs\":{\"max\":{\"max\":{\"field\":\"usedCPUInPercentage\"}}}}},\"size\":0}",
"status": "OK",
"recipients": "someone@my-org.com",
"apiReference": "00000000-0000-0000-0000-a10000000001",
"queryName": "Devices_CPU",
"queryId": 1,
"filters": ":timeRangeType-recent:timeRangePeriod-3600000",
"threshold": 0
}

error:

{
"summary": "Exception:Reference test not found in QueryMetadata table (org.montier.alerts.rest.QueryResource.executeQuery(QueryResource.java:58))",
"message": "Reference test not found in QueryMetadata table",
"status": "error"
}

IBM DataPower Operations Dashboard (DPOD) v1.0.6.0