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 APIedit
Stops one or more transforms.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Requestedit
POST _data_frame/transforms/<transform_id>/_stop
POST _data_frame/transforms/<transform_id1>,<transform_id2>/_stop
POST _data_frame/transforms/_all/_stop
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have
manage_data_frame_transformscluster privileges to use this API. The built-indata_frame_transforms_adminrole has these privileges. For more information, see Security privileges and Built-in roles.
Descriptionedit
You 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
<data_frame_transform_id>.
Path parametersedit
-
<transform_id> - (string) Required. 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 parametersedit
-
timeout -
(time value) Optional. If
wait_for_completion=true, the API blocks for (at maximum) the specified duration while waiting for the transform to stop. If more thantimeouttime 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 -
(boolean) Optional. 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.
Examplesedit
POST _data_frame/transforms/ecommerce_transform/_stop
When the transform stops, you receive the following results:
{
"acknowledged" : true
}