POST Stop: Stop One or More Channels - AWS Elemental Conductor Live 3

This is version 3.17 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

POST Stop: Stop One or More Channels

Stop one or more channels. If the specified channels are currently running on their nodes, then they will stop. If the channels are not running, nothing happens.

The channel must be in a state that allows it to be stopped. To check the state and determine its status, use GET Channel. For information on the status, see Channel Status Elements.

HTTP Request and Response

Request URL

POST http://<Conductor IP address>/channels/stop/

Call Header

  • Accept: Set to application/xml

  • Content-Type: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Request Body

The request contains XML content consisting of one channel_ids element (of type “array”)

with the following.

  • One or more channel_id elements, one for each channel to stop.

Response

The response contains XML content consisting of one task_report element, containing the same elements as the response for GET One Task Report. The failed count and success count may both specify 0. The entire element may be missing, indicating that no actions have been performed yet.