Get data frame analytics jobs
Generally available; Added in 7.7.0
Get configuration and usage information about data frame analytics jobs.
IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
Required authorization
- Cluster privileges:
monitor_ml
Query parameters
-
Whether to ignore if a wildcard expression matches no configs. (This includes
_all
string or when no configs have been specified) -
The unit in which to display byte values
Values are
b
,kb
,mb
,gb
,tb
, orpb
. -
Comma-separated list of column names to display.
-
Comma-separated list of column names or column aliases used to sort the response.
-
Unit used to display time values.
Values are
nanos
,micros
,ms
,s
,m
,h
, ord
.
GET
/_cat/ml/data_frame/analytics/{id}
curl \
--request GET 'http://api.example.com/_cat/ml/data_frame/analytics/{id}' \
--header "Authorization: $API_KEY"
Response examples (200)
A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.
[
{
"id": "classifier_job_1",
"type": "classification",
"create_time": "2020-02-12T11:49:09.594Z",
"state": "stopped"
},
{
"id": "classifier_job_2",
"type": "classification",
"create_time": "2020-02-12T11:49:14.479Z",
"state": "stopped"
},
{
"id": "classifier_job_3",
"type": "classification",
"create_time": "2020-02-12T11:49:16.928Z",
"state": "stopped"
},
{
"id": "classifier_job_4",
"type": "classification",
"create_time": "2020-02-12T11:49:19.127Z",
"state": "stopped"
},
{
"id": "classifier_job_5",
"type": "classification",
"create_time": "2020-02-12T11:49:21.349Z",
"state": "stopped"
}
]