AgentResource
Monitors and controls Flux agents.
The following resources are part of this group:
- /agents
- /agents/configuration
- /agents/copyConfigurationToRepository
- /agents/dispose
- /agents/interrupt
- /agents/setConfigurationFromRepository
- /agents/start
- /agents/stop
/agents
GET
Returns information about all Flux agents that are registered with any Flux engine in this cluster.
Response Body
| element: | agents |
| media types: | application/xml application/json |
Returns information about all Flux agents that are registered with any Flux engine in this cluster.
/agents/configuration
GET
Gets the agent configuration.
Parameters
| name | description | type | default |
|---|---|---|---|
| id_name | Unique id_name for an agent. | query |
Response Body
| element: | agentConfiguration |
| media types: | application/xml application/json |
Returns information if there was an error getting agent configuration.
POST
Restarts the agent configuration.
Request Body
| element: | (custom) |
| media types: | */* application/xml |
The updated agent configuration to be applied.
Response Body
| element: | (custom) |
| media types: | text/plain |
Returns information if there was an error applying agent configuration.
/agents/copyConfigurationToRepository
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| id_name | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/agents/dispose
POST
Unregisters this agent and then shuts it down.
Parameters
| name | description | type | default |
|---|---|---|---|
| id_name | Unique id_name for an agent. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
Returns information if there was an error disposing agent.
/agents/interrupt
POST
Interrupts the currently executing process on the specified agent. The running process will be destroyed only if it is running synchronously and its destory on interrupt flag is enabled.
Parameters
| name | description | type | default |
|---|---|---|---|
| id_name | Unique id_name for an agent. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
Returns information if there was an error interrupting agent.
/agents/setConfigurationFromRepository
GET
Parameters
| name | description | type | default |
|---|---|---|---|
| namespace | (no documentation provided) | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/agents/start
POST
Starts the specified agent. A started agent can accept requests from Flux engines to run processes.
Parameters
| name | description | type | default |
|---|---|---|---|
| id_name | Unique id_name for an agent. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
Returns information if there was an error starting agent.
/agents/stop
POST
Stops the specified agent. A stopped agent does not accept any new requests to run processes. If a process is currently executing, this method blocks until that process finishes.
Parameters
| name | description | type | default |
|---|---|---|---|
| id_name | Unique id_name for an agent. | form |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
Returns information if there was an error stopping agent.