[DOCS] Adds data frame API response codes for allow_no_match (#43666)
This commit is contained in:
parent
42cb59f7b4
commit
1b7bcdc3a0
|
@ -22,7 +22,7 @@ Deletes an existing {dataframe-transform}.
|
||||||
[[delete-data-frame-transform-prereqs]]
|
[[delete-data-frame-transform-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
|
||||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||||
`data_frame_transforms_admin` role has these privileges. For more information,
|
`data_frame_transforms_admin` 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
|
||||||
|
|
|
@ -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]
|
[discrete]
|
||||||
//[[get-data-frame-transform-stats-desc]]
|
[[get-data-frame-transform-stats-desc]]
|
||||||
//===== {api-description-title}
|
==== {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,9 +62,18 @@ 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
|
(boolean) Specifies what to do when the request:
|
||||||
{dataframe-transforms}. This includes `_all` string or when no transforms have
|
+
|
||||||
been specified. The default is `true`.
|
--
|
||||||
|
* 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
|
(integer) Skips the specified number of {dataframe-transforms}. The
|
||||||
|
@ -76,6 +91,13 @@ see {stack-ov}/security-privileges.html[Security privileges] and
|
||||||
(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]]
|
||||||
==== Examples
|
==== Examples
|
||||||
|
|
|
@ -30,12 +30,22 @@ Retrieves configuration information for {dataframe-transforms}.
|
||||||
[[get-data-frame-transform-prereqs]]
|
[[get-data-frame-transform-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-desc]]
|
||||||
|
==== {api-description-title}
|
||||||
|
|
||||||
|
You can get information for multiple {dataframe-transforms} in a single API
|
||||||
|
request by using a comma-separated list of identifiers or a wildcard expression.
|
||||||
|
You can get information 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-path-parms]]
|
[[get-data-frame-transform-path-parms]]
|
||||||
==== {api-path-parms-title}
|
==== {api-path-parms-title}
|
||||||
|
@ -51,9 +61,18 @@ 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
|
(boolean) Specifies what to do when the request:
|
||||||
{dataframe-transforms}. This includes `_all` string or when no transforms have
|
+
|
||||||
been specified. The default is `true`.
|
--
|
||||||
|
* 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
|
(integer) Skips the specified number of {dataframe-transforms}. The
|
||||||
|
@ -71,6 +90,13 @@ see {stack-ov}/security-privileges.html[Security privileges] and
|
||||||
(array) An array of transform resources, which are sorted by the `id` value in
|
(array) An array of transform resources, which are sorted by the `id` value in
|
||||||
ascending order.
|
ascending order.
|
||||||
|
|
||||||
|
[[get-data-frame-transform-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-example]]
|
[[get-data-frame-transform-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
|
@ -22,7 +22,7 @@ Previews a {dataframe-transform}.
|
||||||
[[preview-data-frame-transform-prereq]]
|
[[preview-data-frame-transform-prereq]]
|
||||||
==== {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
|
||||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||||
`data_frame_transforms_admin` role has these privileges. You must also have
|
`data_frame_transforms_admin` role has these privileges. You must also have
|
||||||
`read` and `view_index_metadata` privileges on the source index for the
|
`read` and `view_index_metadata` privileges on the source index for the
|
||||||
|
|
|
@ -22,7 +22,7 @@ Instantiates a {dataframe-transform}.
|
||||||
[[put-data-frame-transform-prereqs]]
|
[[put-data-frame-transform-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
|
||||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||||
`data_frame_transforms_admin` role has these privileges. You must also
|
`data_frame_transforms_admin` role has these privileges. You must also
|
||||||
have `read` and `view_index_metadata` privileges on the source index and `read`,
|
have `read` and `view_index_metadata` privileges on the source index and `read`,
|
||||||
|
@ -30,10 +30,9 @@ have `read` and `view_index_metadata` privileges on the source index and `read`,
|
||||||
information, see {stack-ov}/security-privileges.html[Security privileges] and
|
information, 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]
|
[discrete]
|
||||||
[[put-data-frame-transform-desc]]
|
[[put-data-frame-transform-desc]]
|
||||||
===== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
|
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
|
||||||
Do not put a {dataframe-transform} directly into any
|
Do not put a {dataframe-transform} directly into any
|
||||||
|
|
|
@ -22,7 +22,7 @@ Starts one or more {dataframe-transforms}.
|
||||||
[[start-data-frame-transform-prereqs]]
|
[[start-data-frame-transform-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
|
||||||
`manage_data_frame_transforms` cluster privileges to use this API. You must also
|
`manage_data_frame_transforms` cluster privileges to use this API. You must also
|
||||||
have `view_index_metadata` privileges on the source index for the
|
have `view_index_metadata` privileges on the source index for the
|
||||||
{dataframe-transform}. For more information, see
|
{dataframe-transform}. For more information, see
|
||||||
|
|
|
@ -26,7 +26,7 @@ Stops one or more {dataframe-transforms}.
|
||||||
[[stop-data-frame-transform-prereq]]
|
[[stop-data-frame-transform-prereq]]
|
||||||
==== {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
|
||||||
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
`manage_data_frame_transforms` cluster privileges to use this API. The built-in
|
||||||
`data_frame_transforms_admin` role has these privileges. For more information,
|
`data_frame_transforms_admin` 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
|
||||||
|
@ -55,9 +55,23 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the
|
||||||
==== {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
|
(boolean) Specifies what to do when the request:
|
||||||
{dataframe-transforms}. This includes `_all` string or when no transforms have
|
+
|
||||||
been specified. The default is `true`.
|
--
|
||||||
|
* 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 a successful acknowledgement message
|
||||||
|
when there are no matches. When there are only partial matches, the API stops
|
||||||
|
the appropriate {dataframe-transforms}. For example, if the request contains
|
||||||
|
`test-id1*,test-id2*` as the identifiers and there are no {dataframe-transforms}
|
||||||
|
that match `test-id2*`, the API nonetheless stops the {dataframe-transforms}
|
||||||
|
that match `test-id1*`.
|
||||||
|
|
||||||
|
If this parameter is `false`, the request returns a `404` status code when there
|
||||||
|
are no matches or only partial matches.
|
||||||
|
--
|
||||||
|
|
||||||
`timeout` (Optional)::
|
`timeout` (Optional)::
|
||||||
(time value) If `wait_for_completion=true`, the API blocks for (at maximum)
|
(time value) If `wait_for_completion=true`, the API blocks for (at maximum)
|
||||||
|
@ -72,6 +86,14 @@ All {dataframe-transforms} can be stopped by using `_all` or `*` as the
|
||||||
completely stops. If set to `false`, the API returns immediately and the
|
completely stops. If set to `false`, the API returns immediately and the
|
||||||
indexer will be stopped asynchronously in the background. Defaults to `false`.
|
indexer will be stopped asynchronously in the background. Defaults to `false`.
|
||||||
|
|
||||||
|
[discrete]
|
||||||
|
[[stop-data-frame-transform-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]
|
||||||
[[stop-data-frame-transform-example]]
|
[[stop-data-frame-transform-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
|
@ -12,7 +12,6 @@ A job can be opened and closed multiple times throughout its lifecycle.
|
||||||
A closed job cannot receive data or perform analysis
|
A closed job cannot receive data or perform analysis
|
||||||
operations, but you can still explore and navigate results.
|
operations, but you can still explore and navigate results.
|
||||||
|
|
||||||
[discrete]
|
|
||||||
[[ml-close-job-request]]
|
[[ml-close-job-request]]
|
||||||
==== {api-request-title}
|
==== {api-request-title}
|
||||||
|
|
||||||
|
@ -55,7 +54,6 @@ after the close job API returns. The `force` query parameter should only be use
|
||||||
situations where the job has already failed, or where you are not interested in
|
situations where the job has already failed, or where you are not interested in
|
||||||
results the job might have recently produced or might produce in the future.
|
results the job might have recently produced or might produce in the future.
|
||||||
|
|
||||||
[discrete]
|
|
||||||
[[ml-close-job-path-parms]]
|
[[ml-close-job-path-parms]]
|
||||||
==== {api-path-parms-title}
|
==== {api-path-parms-title}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue