|
@@ -31,15 +31,21 @@ Retrieves usage information for {dataframe-transforms}.
|
|
[[get-data-frame-transform-stats-prereqs]]
|
|
[[get-data-frame-transform-stats-prereqs]]
|
|
==== {api-prereq-title}
|
|
==== {api-prereq-title}
|
|
|
|
|
|
-If the {es} {security-features} are enabled, you must have
|
|
|
|
|
|
+* If the {es} {security-features} are enabled, you must have
|
|
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
|
|
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
|
|
`data_frame_transforms_user` role has these privileges. For more information,
|
|
`data_frame_transforms_user` role has these privileges. For more information,
|
|
see {stack-ov}/security-privileges.html[Security privileges] and
|
|
see {stack-ov}/security-privileges.html[Security privileges] and
|
|
{stack-ov}/built-in-roles.html[Built-in roles].
|
|
{stack-ov}/built-in-roles.html[Built-in roles].
|
|
|
|
|
|
-//[discrete]
|
|
|
|
-//[[get-data-frame-transform-stats-desc]]
|
|
|
|
-//===== {api-description-title}
|
|
|
|
|
|
+[discrete]
|
|
|
|
+[[get-data-frame-transform-stats-desc]]
|
|
|
|
+==== {api-description-title}
|
|
|
|
+
|
|
|
|
+You can get statistics for multiple {dataframe-transforms} in a single API
|
|
|
|
+request by using a comma-separated list of identifiers or a wildcard expression.
|
|
|
|
+You can get statistics for all {dataframe-transforms} by using `_all`, by
|
|
|
|
+specifying `*` as the `<data_frame_transform_id>`, or by omitting the
|
|
|
|
+`<data_frame_transform_id>`.
|
|
|
|
|
|
[discrete]
|
|
[discrete]
|
|
[[get-data-frame-transform-stats-path-parms]]
|
|
[[get-data-frame-transform-stats-path-parms]]
|
|
@@ -56,17 +62,26 @@ see {stack-ov}/security-privileges.html[Security privileges] and
|
|
==== {api-query-parms-title}
|
|
==== {api-query-parms-title}
|
|
|
|
|
|
`allow_no_match` (Optional)::
|
|
`allow_no_match` (Optional)::
|
|
- (boolean) Whether to ignore if a wildcard expression matches no
|
|
|
|
- {dataframe-transforms}. This includes `_all` string or when no transforms have
|
|
|
|
- been specified. The default is `true`.
|
|
|
|
|
|
+ (boolean) Specifies what to do when the request:
|
|
|
|
++
|
|
|
|
+--
|
|
|
|
+* Contains wildcard expressions and there are no {dataframe-transforms} 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 `transforms` 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)::
|
|
`from` (Optional)::
|
|
- (integer) Skips the specified number of {dataframe-transforms}. The
|
|
|
|
- default value is `0`.
|
|
|
|
|
|
+ (integer) Skips the specified number of {dataframe-transforms}. The
|
|
|
|
+ default value is `0`.
|
|
|
|
|
|
`size` (Optional)::
|
|
`size` (Optional)::
|
|
- (integer) Specifies the maximum number of {dataframe-transforms} to obtain.
|
|
|
|
- The default value is `100`.
|
|
|
|
|
|
+ (integer) Specifies the maximum number of {dataframe-transforms} to obtain.
|
|
|
|
+ The default value is `100`.
|
|
|
|
|
|
[discrete]
|
|
[discrete]
|
|
[[get-data-frame-transform-stats-response]]
|
|
[[get-data-frame-transform-stats-response]]
|
|
@@ -75,6 +90,13 @@ see {stack-ov}/security-privileges.html[Security privileges] and
|
|
`transforms`::
|
|
`transforms`::
|
|
(array) An array of statistics objects for {dataframe-transforms}, which are
|
|
(array) An array of statistics objects for {dataframe-transforms}, which are
|
|
sorted by the `id` value in ascending order.
|
|
sorted by the `id` value in ascending order.
|
|
|
|
+
|
|
|
|
+[[get-data-frame-transform-stats-response-codes]]
|
|
|
|
+==== {api-response-codes-title}
|
|
|
|
+
|
|
|
|
+`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.
|
|
|
|
|
|
[discrete]
|
|
[discrete]
|
|
[[get-data-frame-transform-stats-example]]
|
|
[[get-data-frame-transform-stats-example]]
|