Stop data frame analytics jobs API
editStop data frame analytics jobs API
editStops one or more data frame analytics jobs.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Request
editPOST _ml/data_frame/analytics/<data_frame_analytics_id>/_stop
POST _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stop
POST _ml/data_frame/analytics/_all/_stop
Prerequisites
edit-
You must have
machine_learning_adminbuilt-in role to use this API. For more information, see Security privileges and Built-in roles.
Description
editA data frame analytics job can be started and stopped multiple times throughout its lifecycle.
You can stop multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. You can stop all data frame analytics job by using _all or by specifying * as the <data_frame_analytics_id>.
Path parameters
edit-
<data_frame_analytics_id> - (Required, string) Identifier for the data frame analytics job. 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) If
falseand thedata_frame_analytics_iddoes not match any data frame analytics job an error will be returned. The default value istrue. -
force - (Optional, boolean) If true, the data frame analytics job is stopped forcefully.
-
timeout - (Optional, time) Controls the amount of time to wait until the data frame analytics job stops. The default value is 20 seconds.
Examples
editThe following example stops the loganalytics data frame analytics job:
POST _ml/data_frame/analytics/loganalytics/_stop
When the data frame analytics job stops, you receive the following results:
{
"stopped" : true
}