Get data frame analytics job configuration info
Generally available
All methods and paths for this operation:
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.
Required authorization
- Cluster privileges:
monitor_ml
Path parameters
-
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.
Query parameters
-
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 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. -
Skips the specified number of data frame analytics jobs.
-
Specifies the maximum number of data frame analytics jobs to obtain.
-
Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.
GET _ml/data_frame/analytics/loganalytics
resp = client.ml.get_data_frame_analytics(
id="loganalytics",
)
const response = await client.ml.getDataFrameAnalytics({
id: "loganalytics",
});
response = client.ml.get_data_frame_analytics(
id: "loganalytics"
)
$resp = $client->ml()->getDataFrameAnalytics([
"id" => "loganalytics",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics"
client.ml().getDataFrameAnalytics(g -> g
.id("loganalytics")
);