Get data frame analytics jobs statistics API | Elasticsearch Guide [7.3]

IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

« Get data frame analytics jobs API Start data frame analytics jobs API »

Get data frame analytics jobs statistics APIedit

Retrieves usage information for data frame analytics jobs.

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

GET _ml/data_frame/analytics/<data_frame_analytics_id>/_stats

GET _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stats

GET _ml/data_frame/analytics/_stats

GET _ml/data_frame/analytics/_all/_stats

GET _ml/data_frame/analytics/*/_stats

Prerequisitesedit

You must have monitor_ml privilege to use this API. For more information, see Security privileges and Built-in roles.

Path parametersedit

<data_frame_analytics_id>: (Optional, string)Identifier for the data frame analytics job. If you do not specify one of these options, the API returns information for the first hundred data frame analytics jobs.

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 _all string 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 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.

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

The API returns the following information:

data_frame_analytics: (array) An array of statistics objects for data frame analytics jobs, which are sorted by the id value in ascending order.

Response codesedit

404 (Missing resources): If allow_no_match is false, this code indicates that there are no resources that match the request or only partial matches for the request.

Examplesedit

GET _ml/data_frame/analytics/loganalytics/_stats

The API returns the following results:

{
    "count": 1,
    "data_frame_analytics": [
        {
            "id": "loganalytics",
            "state": "stopped"
        }
    ]
}

« Get data frame analytics jobs API Start data frame analytics jobs API »