EngineAdmin
EngineAdmin APIs provide administrative access to Engines on a Broker. They are listed in the following table:
|
Method |
Method Type |
Description |
|
GET |
Retrieves information about all Engines logged in to the Broker. |
|
|
GET |
Retrieves the total number of Engines logged in to the Broker and are currently executing a task. |
|
|
GET |
Retrieves the total number of Engines logged in to the Broker. |
|
|
GET |
Retrieves the list of Engine IDs logged in to the Broker. |
|
|
GET |
Retrieves information about a given Engine. |
|
|
POST |
Retrieves information about Engines logged in to the Broker that match the Engine Condition. |
|
|
GET |
Retrieves the log file URLs on a given Engine when the Engine logging is enabled on the Server. |
|
|
POST |
Retrieves information, which includes all instances for the given IDs, about given Engines logged in to the Broker. |
|
|
GET |
Retrieves whether the methods are available. |
|
|
PUT |
Logs out all the Engines from the Broker. |
|
|
PUT |
Logs out a given Engine from the Broker. |
|
| park-engines | POST | Sets Engine's parked flag to true for passed Engine IDs. |
| unpark-engines | POST | Sets Engine's parked flag to false for passed Engine IDs. |
| parked-engines | GET | Retrieves the list of Engine IDs that have the parked flag set to true. |