Stop data frame analytics jobs Generally available; Added in 7.3.0

View as markdown
POST /_ml/data_frame/analytics/{id}/_stop
Api key auth Basic auth Bearer auth

A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

Required authorization

  • Cluster privileges: manage_ml

Path parameters

  • id string Required

    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:

    1. Contains wildcard expressions and there are no data frame analytics jobs that match.
    2. Contains the _all string or no identifiers and there are no matches.
    3. 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.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • stopped boolean Required
POST /_ml/data_frame/analytics/{id}/_stop 
POST _ml/data_frame/analytics/loganalytics/_stop

resp = client.ml.stop_data_frame_analytics(
    id="loganalytics",
)
const response = await client.ml.stopDataFrameAnalytics({
  id: "loganalytics",
});
response = client.ml.stop_data_frame_analytics(
  id: "loganalytics"
)
$resp = $client->ml()->stopDataFrameAnalytics([
    "id" => "loganalytics",
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics/_stop"
client.ml().stopDataFrameAnalytics(s -> s
    .id("loganalytics")
);