IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Start data frame analytics jobs APIedit
Starts a data frame analytics job.
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.
Requestedit
POST _ml/data_frame/analytics/<data_frame_analytics_id>/_start
Prerequisitesedit
-
You must have
machine_learning_admin
built-in role to use this API. You must also haveread
andview_index_metadata
privileges on the source index andread
,create_index
, andindex
privileges on the destination index. For more information, see Security privileges and Built-in roles.
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
-
timeout
- (Optional, time) Controls the amount of time to wait until the data frame analytics job starts. The default value is 20 seconds.
Examplesedit
The following example starts the loganalytics
data frame analytics job:
POST _ml/data_frame/analytics/loganalytics/_start
When the data frame analytics job starts, you receive the following results:
{ "acknowledged" : true }