Stop data frame analytics jobs APIedit
Stops one or more data frame analytics jobs.
This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
Requestedit
POST _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
Prerequisitesedit
If the Elasticsearch security features are enabled, you must have the following built-in roles or equivalent privileges:
-
machine_learning_admin -
kibana_admin(UI only)
For more information, see Security privileges and Built-in roles.
Descriptionedit
A 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 parametersedit
-
<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 parametersedit
-
allow_no_match -
(Optional, boolean) Specifies what to do when the request:
- Contains wildcard expressions and there are no data frame analytics jobs that match.
-
Contains the
_allstring or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
The default value is
true, which returns an emptydata_frame_analyticsarray when there are no matches and the subset of results when there are partial matches. If this parameter isfalse, the request returns a404status code when there are no matches or only partial matches. -
force - (Optional, boolean) If true, the data frame analytics job is stopped forcefully.
-
timeout - (Optional, time units) Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.
Examplesedit
The 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
}