Manage AFA notifications
Use the following request methods to manage notifications in the AFA Notification Center. In previous versions of ASMS, the Notifications Center was called Issues Center, and notifications were called issues.
Note:
Retrieve unresolved notifications
The get_issues request retrieves all the unresolved notifications in the AFA Notification Center. This includes both acknowledged and active notifications .
Resource Name:/ms-watchdog/v1/api/issues-center/issues
Request Method: POST
Authentication: Cookie with session ID.
Request URL Parameters:
Element |
Type |
Description |
---|---|---|
sizeOptional |
Integer |
Number of results per page. The default value is 10. |
pageOptional |
Integer |
Page number to return. The default value is 0 (the first page). Note: This element requires a definition for size. Defining this element without size will cause the return to be empty. |
sortColumnOptional |
String |
The column / notification attribute to sort by. One of the elements of the |
sortDirectionOptional |
String |
The sort direction. One of the following:
|
Request Body:
(Optional) A map of column names and values.
The response will only include notifications which match the specified value(s) for the specified columns.
The column name can be any of the elements of the issueAttributes
, issue
, or device
objects. See IssueAttributes type.
Response:
Element |
Type |
Description |
---|---|---|
content
|
Array |
An array of |
Various elements that describe the paging of the notifications . |
See the spring framework for more information. |
Request example
https://<ASMS_Server>/ms-watchdog/v1/api/issues-center/issues?size=13&page=0&sortColumn=lastFailure&sortDirection=DESC
{"nodeType":"MASTER","issue.type":"System"}
Response example
{ "content":[ { "id":1, "status":"OPEN", "lastFailure":"2019-05-01T14:33:40.369", "lastSuccess":null, "count":15, "nodeType":"MASTER", "nodeName":"10.20.15.82", "issue":{ "type":"System", "failureType":"Disk space", "description":"Low free disk space on /data", "remediation":"- Configure/change the backup configuration for a smaller retention size\n- Delete temporary files.", "kbLink":"" }, "device":null }, { "id":357, "status":"ACKNOWLEDGED", "lastFailure":"2019-04-24T08:26:45.264", "lastSuccess":"2019-04-21T10:18:19.033", "count":818, "nodeType":"MASTER", "nodeName":"10.20.15.82", "issue":{ "type":"System", "failureType":"Disk space", "description":"Low free disk space", "remediation":"- Configure/change the backup configuration for a smaller retention size\n- Delete temporary files", "kbLink":"" }, "device":null }, { "id":133, "status":"ACKNOWLEDGED", "lastFailure":"2019-04-24T08:26:45.06", "lastSuccess":null, "count":1893, "nodeType":"MASTER", "nodeName":"10.20.15.82", "issue":{ "type":"System", "failureType":"DFS", "description":"Synchronization error", "remediation":"Synchronization error on node", "kbLink":"" }, "device":null }, ], "pageable":"INSTANCE", "last":true, "totalPages":1, "totalElements":6, "sort":{ "sorted":false, "unsorted":true, "empty":true }, "first":true, "numberOfElements":6, "size":0, "number":0, "empty":false }
Acknowledge an notifications
The acknowledge request marks active notifications in the AFA Notification Center as acknowledged. Notifications marked as acknowledged will appear in the list of acknowledged notifications and will no longer appear in the list of active notifications.
Resource Name:/ms-watchdog/v1/api/issues-center/issues/acknowledge
Request Method: POST
Authentication: Cookie with session ID.
Request Body: Any array of notification IDs. To retrieve the notification IDs, see Retrieve unresolved notifications .
Response:
Element |
Type |
Description |
---|---|---|
|
String |
The new status of the notifications: ACKNOWLEDGED. |
updatedIssues
|
Array |
An array of notification IDs. |
successful
|
Boolean |
Whether the request was successful. |
Request example
#/ms-watchdog/v1/api/issues-center/issues/acknowledge
[2,4]
Response example
{ "newStatus":"ACKNOWLEDGED", "updatedIssues":[ 2, 4 ], "successful":true }
Activate an notifications
The activate request marks acknowledged notifications in the AFA Notification Center as active. Notifications marked as active will appear in the list of active notifications and will no longer appear in the list of acknowledged notifications .
Resource Name:/ms-watchdog/v1/api/issues-center/issues/activate
Request Method: POST
Authentication: Cookie with session ID.
Request Body: Any array of notification IDs. To retrieve the notification IDs, see Retrieve unresolved notifications .
Response:
Element |
Type |
Description |
---|---|---|
|
String |
The new status of the notifications: OPEN. |
updatedIssues
|
Array |
An array of notification IDs. |
successful
|
Boolean |
Whether the request was successful. |
Request example
#/ms-watchdog/v1/api/issues-center/issues/activate
[2,4]
Response example
{ "newStatus":"OPEN", "updatedIssues":[ 2, 4 ], "successful":true }