Stop data frame analytics jobs Added in 7.3.0
A data frame analytics job can be started and stopped multiple times throughout its lifecycle.
Path parameters
-
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
-
allow_no_match boolean
Specifies what to do when the request:
- Contains wildcard expressions and there are no data frame analytics jobs 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 an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.
-
force boolean
If true, the data frame analytics job is stopped forcefully.
-
timeout string
Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.
curl \
-X POST http://api.example.com/_ml/data_frame/analytics/{id}/_stop
{
"stopped": true
}