MonitorResource
Rest Resource containing various end-points regarding system resource monitoring (disk, ram, etc.), to access and manipulate lists of objects associated with resource monitoring data. Copyright 2013 WANdisco.
The following resources are part of this group:
- /monitor
- /monitor/{monitorId}
- /monitor/{monitorId}/addCondition
- /monitor/{monitorId}/removeCondition
/monitor
Mount Point: /api/monitor
POST
creates and adds a new monitor, based on monitor DTO passed in.
Request Body
| element: | monitor |
| media types: | application/xml application/json |
monitor to be created and added to the manager.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
uri of a new resource monitor
PUT
Updates the existing resource monitor with the information passed in the MonitorDTO, but only if the old monitor with the same identity as the new monitor exists.
Request Body
| element: | monitor |
| media types: | application/xml application/json |
monitor to be created and used to replace the old monitor.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/monitor/{monitorId}
Mount Point: /api/monitor/{monitorId}
GET
Responds with a monitor object, with matching identity, if exists.
Parameters
| name | description | type | default |
|---|---|---|---|
| monitorId | identity of resource monitor | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
monitor with requested identity.
DELETE
Removes a monitor specified by identity, if such monitor exists.
Parameters
| name | description | type | default |
|---|---|---|---|
| monitorId | identity of resource monitor | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/monitor/{monitorId}/addCondition
Mount Point: /api/monitor/{monitorId}/addCondition
POST
Adds a new condition-event pair to the existing monitor, denoted by the monitorId, if such a monitor exists.
Parameters
| name | description | type | default |
|---|---|---|---|
| monitorId | identity of resource monitor | path |
Request Body
| element: | conditionEventPair |
| media types: | */* application/xml |
a new condition-event pair to be added
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/monitor/{monitorId}/removeCondition
Mount Point: /api/monitor/{monitorId}/removeCondition
PUT
Removes a condition-event pair from the existing monitor, denoted by the monitorId, if such monitor exists and if such condition-event pair exists, otherwise error codes are returned.
Parameters
| name | description | type | default |
|---|---|---|---|
| monitorId | identity of resource monitor | path |
Request Body
| element: | conditionEventPair |
| media types: | */* application/xml |
a new condition-event pair to be removed
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)