This API end point lets you control or interrogate the redundancy properties for redundant M&Cs.
Supported HTTP methods: GET, PUT, HEAD, OPTIONS
GET /api/v1/redundancy/{mncName}
Queries the state of the redundancy control logic for the given M&C
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C to query. |
Expected Payload: none.
Replied Payload: A RedundancyState object reporting the redundancy properties of the M&C.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, a RedundancyState document is returned. |
| 400 | The requested M&C system is not configured as a redundant pair. In this case an ApiError document is returned, describing details of the error. |
| 404 | The requested M&C system does not exist. In this case an ApiError document is returned, describing details of the error. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
GET /api/v1/redundancy
Queries the state of the redundancy control logic for all redundant M&Cs.
Parameters: none.
Expected Payload: none.
Replied Payload: A RedundancySummary object reporting the redundancy properties of all redundant M&Cs.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, a RedundancySummary document is returned. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
PUT /api/v1/redundancy/{mncName}
Sends a redundancy command to either switch a redundant M&C pair or to enable/disable the M&C redundancy.
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C to send the redundancy command to. |
Expected Payload: A RedundancyCmd document containing the command to send.
Replied Payload: A copy of the RedundancyCmd which has been sent.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, the echoed RedundancyCmd document is returned. |
| 404 | The requested M&C system does not exist. In this case an ApiError document is returned, describing details of the error. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |