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
editIf the Elasticsearch security features are enabled, you must have the following built-in roles and privileges:
-
manage_transform
The built-in transform_admin
role has this privilege.
For more information, see Security privileges and Built-in roles.
Description
editYou can stop multiple transforms in a single API request by using a
comma-separated list of transforms or a wildcard expression.
All transforms can be stopped by using _all
or *
as the
<transform_id>
.
Path parameters
edit-
<transform_id>
- (Required, string) Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
Query parameters
edit-
allow_no_match
-
(Optional, boolean) Specifies what to do when the request:
- Contains wildcard expressions and there are no transforms that match.
-
Contains the
_all
string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
The default value is
true
, which returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. For example, if the request containstest-id1*,test-id2*
as the identifiers and there are no transforms that matchtest-id2*
, the API nonetheless stops the transforms that matchtest-id1*
.If this parameter is
false
, the request returns a404
status code when there are no matches or only partial matches. -
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_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
. -
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
.
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 }