Get data frame analytics jobs APIedit
Retrieves configuration information for 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
GET _ml/data_frame/analytics/<data_frame_analytics_id>
GET _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>
GET _ml/data_frame/analytics/
GET _ml/data_frame/analytics/_all
Prerequisitesedit
If the Elasticsearch security features are enabled, you must have the following privileges:
-
cluster:
monitor_ml
For more information, see Security privileges and Built-in roles.
Descriptionedit
You can get information for 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.
Path parametersedit
-
<data_frame_analytics_id> -
(Optional, string) Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.
You can get information for all data frame analytics jobs by using _all, by specifying
*as the<data_frame_analytics_id>, or by omitting the<data_frame_analytics_id>.
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. -
from -
(Optional, integer)
Skips the specified number of data frame analytics jobs. The default value is
0. -
size -
(Optional, integer)
Specifies the maximum number of data frame analytics jobs to obtain. The default value
is
100.
Response bodyedit
-
data_frame_analytics -
(array) An array of data frame analytics job resources, which are sorted by the
idvalue in ascending order.Properties of data frame analytics job resources
-
analysis -
(object) The type of analysis that is performed on the
source.
-
analyzed_fields -
(object) Contains
includesand/orexcludespatterns that select which fields are included in the analysis.Properties of
analyzed_fields-
excludes - (Optional, array) An array of strings that defines the fields that are excluded from the analysis.
-
includes - (Optional, array) An array of strings that defines the fields that are included in the analysis.
-
-
dest -
(string) The destination configuration of the analysis.
Properties of
dest-
index - (string) The destination index that stores the results of the data frame analytics job.
-
results_field -
(string) The name of the field that stores the results of the analysis. Defaults
to
ml.
-
-
id - (string) The unique identifier of the data frame analytics job.
-
model_memory_limit -
(string) The
model_memory_limitthat has been set to the data frame analytics job. -
source -
(object) The configuration of how the analysis data is sourced. It has an
indexparameter and optionally aqueryand a_source.Properties of
source-
index - (array) Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns.
-
query -
(object) The query that has been specified for the data frame analytics job. The Elasticsearch
query domain-specific language (DSL). This value corresponds to
the query object in an Elasticsearch search POST body. By default, this property has the
following value:
{"match_all": {}}. -
_source -
(object) Contains the specified
includesand/orexcludespatterns that select which fields are present in the destination. Fields that are excluded cannot be included in the analysis.Properties of
_source-
excludes - (array) An array of strings that defines the fields that are excluded from the destination.
-
includes - (array) An array of strings that defines the fields that are included in the destination.
-
-
-
Response codesedit
-
404(Missing resources) -
If
allow_no_matchisfalse, this code indicates that there are no resources that match the request or only partial matches for the request.
Examplesedit
The following example gets configuration information for the loganalytics
data frame analytics job:
GET _ml/data_frame/analytics/loganalytics
The API returns the following results:
{
"count": 1,
"data_frame_analytics": [
{
"id": "loganalytics",
"source": {
"index": "logdata",
"query": {
"match_all": {}
}
},
"dest": {
"index": "logdata_out",
"results_field": "ml"
},
"analysis": {
"outlier_detection": {}
},
"model_memory_limit": "1gb",
"create_time": 1562265491319,
"version" : "8.0.0"
}
]
}