IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Stop transforms API
editStop transforms API
editStops one or more transforms.
Request
editPOST _transform/<transform_id>/_stop
POST _transform/<transform_id1>,<transform_id2>/_stop
POST _transform/_all/_stop
Prerequisites
editRequires the manage_transform
cluster privilege. This privilege is included
in the transform_admin
built-in role.
Path parameters
edit-
<transform_id>
-
(Required, string)
Identifier for the transform. To stop multiple transforms, use a
comma-separated list or a wildcard expression. To stop all transforms, use
_all
or*
as the identifier.
Query parameters
edit-
allow_no_match
- (Optional, Boolean) include::/tmp/docsbuild/wKhIKO2ovz/elasticsearch/docs/reference/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms2]
-
force
-
(Optional, Boolean) Set to
true
to stop a failed transform or to forcefully stop a transform that did not respond to the initial stop request. -
timeout
-
(Optional, time value) If
wait_for_completion=true
, the API blocks for (at maximum) the specified duration while waiting for the transform to stop. If more thantimeout
time has passed, the API throws a timeout exception. Even if a timeout exception is thrown, the stop request is still processing and eventually moves the transform toSTOPPED
. The timeout simply means the API call itself timed out while waiting for the status change. Defaults to30s
. -
wait_for_checkpoint
-
(Optional, Boolean) If set to
true
, the transform will not completely stop until the current checkpoint is completed. If set tofalse
, the transform stops as soon as possible. Defaults tofalse
. -
wait_for_completion
-
(Optional, Boolean) If set to
true
, causes the API to block until the indexer state completely stops. If set tofalse
, the API returns immediately and the indexer will be stopped asynchronously in the background. Defaults tofalse
.
Response codes
edit-
404
(Missing resources) -
If
allow_no_match
isfalse
, this code indicates that there are no resources that match the request or only partial matches for the request.
Examples
editPOST _transform/ecommerce_transform/_stop
When the transform stops, you receive the following results:
{ "acknowledged" : true }