parent
bc65b3a590
commit
2665bfffce
|
@ -20,7 +20,7 @@ Returns configuration and usage information about {anomaly-jobs}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>> and {ml-docs}/setup.html[Set up {ml-features}].
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[cat-anomaly-detectors-desc]]
|
||||
|
|
|
@ -20,7 +20,7 @@ Returns configuration and usage information about {dfeeds}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>> and {ml-docs}/setup.html[Set up {ml-features}].
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[cat-datafeeds-desc]]
|
||||
|
|
|
@ -25,7 +25,7 @@ privileges:
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and {ml-docs}/setup.html[Set up {ml-features}].
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
////
|
||||
|
|
|
@ -23,8 +23,7 @@ privileges:
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and
|
||||
{ml-docs}/setup.html[Set up {ml-features}].
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
////
|
||||
|
|
|
@ -8,6 +8,7 @@
|
|||
:es-repo-dir: {elasticsearch-root}/docs/reference
|
||||
|
||||
include::../Versions.asciidoc[]
|
||||
include::links.asciidoc[]
|
||||
|
||||
include::intro.asciidoc[]
|
||||
|
||||
|
|
|
@ -0,0 +1,4 @@
|
|||
// These attributes define common links in the Elasticsearch Reference
|
||||
|
||||
:ml-docs-setup: {ml-docs}/setup.html[Set up {ml-features}]
|
||||
:ml-docs-setup-privileges: {ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges]
|
|
@ -26,7 +26,7 @@ operations, but you can still explore and navigate results.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
* Before you can close an {anomaly-job}, you must stop its {dfeed}. See
|
||||
<<ml-stop-datafeed>>.
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ Deletes scheduled events from a calendar.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-calendar-event-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Deletes {anomaly-jobs} from a calendar.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-calendar-job-path-parms]]
|
||||
== {api-path-parms-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Deletes a calendar.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-calendar-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -22,7 +22,7 @@ Deletes an existing {dfeed}.
|
|||
can delete it.
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-datafeed-path-parms]]
|
||||
== {api-path-parms-title}
|
||||
|
|
|
@ -20,7 +20,7 @@ Deletes expired and unused machine learning data.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-expired-data-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Deletes a filter.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-filter-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -22,7 +22,7 @@ Deletes forecasts from a {ml} job.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-forecast-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -17,7 +17,8 @@ Deletes an existing {anomaly-job}.
|
|||
== {api-prereq-title}
|
||||
|
||||
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
|
||||
cluster privileges to use this API. See <<security-privileges>>.
|
||||
cluster privileges to use this API. See <<security-privileges>> and
|
||||
{ml-docs-setup-privileges}.
|
||||
* Before you can delete a job, you must delete the {dfeeds} that are associated
|
||||
with it. See <<ml-delete-datafeed>>.
|
||||
* Before you can delete a job, you must close it (unless you specify the `force` parameter). See <<ml-close-job>>.
|
||||
|
|
|
@ -17,7 +17,8 @@ Deletes an existing model snapshot.
|
|||
== {api-prereq-title}
|
||||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See <<security-privileges>>.
|
||||
`manage` cluster privileges to use this API. See <<security-privileges>> and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-delete-snapshot-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -19,12 +19,12 @@ fields it references.
|
|||
[[ml-estimate-model-memory-prereqs]]
|
||||
== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have the following
|
||||
equivalent privileges:
|
||||
If the {es} {security-features} are enabled, you must have the following privileges:
|
||||
|
||||
* `manage_ml` or cluster: `manage`
|
||||
|
||||
For more information, see <<security-privileges>>.
|
||||
For more information, see <<security-privileges>> and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-estimate-model-memory-request-body]]
|
||||
|
|
|
@ -23,7 +23,8 @@ suitable to be ingested into {es}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml` or
|
||||
`monitor` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-find-file-structure-desc]]
|
||||
|
|
|
@ -18,7 +18,7 @@ Forces any buffered data to be processed by the job.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-flush-job-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,13 +18,13 @@ Predicts the future behavior of a time series by using its historical behavior.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-forecast-desc]]
|
||||
== {api-description-title}
|
||||
|
||||
You can create a forecast job based on an {anomaly-job} to extrapolate future
|
||||
behavior. Refer to
|
||||
behavior. Refer to
|
||||
{ml-docs}/ml-overview.html#ml-forecasting[Forecasting the future] and
|
||||
{ml-docs}/ml-limitations.html#ml-forecast-limitations[forecast limitations] to
|
||||
learn more.
|
||||
|
|
|
@ -22,9 +22,8 @@ Retrieves {anomaly-job} results for one or more buckets.
|
|||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
|
||||
need `read` index privilege on the index that stores the results. The
|
||||
`machine_learning_admin` and `machine_learning_user` roles provide these
|
||||
privileges. For more information, see
|
||||
<<security-privileges>> and
|
||||
<<built-in-roles>>.
|
||||
privileges. For more information, see <<security-privileges>>,
|
||||
<<built-in-roles>>, and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-bucket-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,7 +20,7 @@ Retrieves information about the scheduled events in calendars.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-calendar-event-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,7 +20,7 @@ Retrieves configuration information for calendars.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-calendar-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -22,8 +22,8 @@ Retrieves {anomaly-job} results for one or more categories.
|
|||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
|
||||
need `read` index privilege on the index that stores the results. The
|
||||
`machine_learning_admin` and `machine_learning_user` roles provide these
|
||||
privileges. See <<security-privileges>> and
|
||||
<<built-in-roles>>.
|
||||
privileges. See <<security-privileges>>, <<built-in-roles>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-category-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -26,7 +26,7 @@ Retrieves usage information for {dfeeds}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-datafeed-stats-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -26,7 +26,7 @@ Retrieves configuration information for {dfeeds}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-datafeed-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,7 +20,7 @@ Retrieves filters.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-filter-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,8 +20,8 @@ Retrieves {anomaly-job} results for one or more influencers.
|
|||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
|
||||
need `read` index privilege on the index that stores the results. The
|
||||
`machine_learning_admin` and `machine_learning_user` roles provide these
|
||||
privileges. See <<security-privileges>> and
|
||||
<<built-in-roles>>.
|
||||
privileges. See <<security-privileges>>, <<built-in-roles>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-influencer-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -24,7 +24,7 @@ Retrieves usage information for {anomaly-jobs}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-job-stats-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -24,7 +24,7 @@ Retrieves configuration information for {anomaly-jobs}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-job-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -21,8 +21,8 @@ Returns defaults and limits used by machine learning.
|
|||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. The
|
||||
`machine_learning_admin` and `machine_learning_user` roles provide these
|
||||
privileges. See <<security-privileges>> and
|
||||
<<built-in-roles>>.
|
||||
privileges. See <<security-privileges>>, <<built-in-roles>> and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[get-ml-info-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -25,7 +25,8 @@ Retrieves overall bucket results that summarize the bucket results of multiple
|
|||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
|
||||
need `read` index privilege on the index that stores the results. The
|
||||
`machine_learning_admin` and `machine_learning_user` roles provide these
|
||||
privileges. See <<security-privileges>> and <<built-in-roles>>.
|
||||
privileges. See <<security-privileges>>, <<built-in-roles>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-overall-buckets-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,7 +20,8 @@ Retrieves anomaly records for an {anomaly-job}.
|
|||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. You also
|
||||
need `read` index privilege on the index that stores the results. The
|
||||
`machine_learning_admin` and `machine_learning_user` roles provide these
|
||||
privileges. See <<security-privileges>> and <<built-in-roles>>.
|
||||
privileges. See <<security-privileges>>, <<built-in-roles>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-record-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,7 +20,7 @@ Retrieves information about model snapshots.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `monitor_ml`,
|
||||
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-snapshot-path-parms]]
|
||||
== {api-path-parms-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Opens one or more {anomaly-jobs}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-open-job-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Posts scheduled events in a calendar.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-post-calendar-event-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Sends data to an anomaly detection job for analysis.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-post-data-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,7 +20,7 @@ Previews a {dfeed}.
|
|||
|
||||
* If {es} {security-features} are enabled, you must have `monitor_ml`, `monitor`,
|
||||
`manage_ml`, or `manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-preview-datafeed-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Adds an {anomaly-job} to a calendar.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-put-calendar-job-path-parms]]
|
||||
== {api-path-parms-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Instantiates a calendar.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-put-calendar-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -20,8 +20,8 @@ Instantiates a {dfeed}.
|
|||
|
||||
* You must create an {anomaly-job} before you create a {dfeed}.
|
||||
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
|
||||
cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
cluster privileges to use this API. See <<security-privileges>> and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-put-datafeed-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Instantiates a filter.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-put-filter-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Instantiates an {anomaly-job}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-put-job-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -19,7 +19,7 @@ Reverts to a specific snapshot.
|
|||
* Before you revert to a saved snapshot, you must close the job.
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-revert-snapshot-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -29,7 +29,7 @@ POST /_ml/set_upgrade_mode?enabled=false&timeout=10m
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-set-upgrade-mode-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -22,7 +22,7 @@ Starts one or more {dfeeds}.
|
|||
error occurs.
|
||||
* If {es} {security-features} are enabled, you must have `manage_ml` or `manage`
|
||||
cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-start-datafeed-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -24,7 +24,7 @@ Stops one or more {dfeeds}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-stop-datafeed-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -22,7 +22,7 @@ Updates certain properties of a {dfeed}.
|
|||
|
||||
* If {es} {security-features} are enabled, you must have `manage_ml`, or `manage`
|
||||
cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-update-datafeed-desc]]
|
||||
|
|
|
@ -18,7 +18,7 @@ Updates the description of a filter, adds items, or removes items.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-update-filter-path-parms]]
|
||||
== {api-path-parms-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Updates certain properties of an {anomaly-job}.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-update-job-path-parms]]
|
||||
|
|
|
@ -18,7 +18,7 @@ Updates certain properties of a snapshot.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-update-snapshot-path-parms]]
|
||||
|
|
|
@ -18,7 +18,7 @@ Validates detector configuration information.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-valid-detector-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -18,7 +18,7 @@ Validates {anomaly-job} configuration information.
|
|||
|
||||
* If the {es} {security-features} are enabled, you must have `manage_ml` or
|
||||
`manage` cluster privileges to use this API. See
|
||||
<<security-privileges>>.
|
||||
<<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-valid-job-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -24,9 +24,8 @@ experimental[]
|
|||
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-delete-dfanalytics-path-params]]
|
||||
|
|
|
@ -25,9 +25,8 @@ experimental[]
|
|||
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-delete-inference-path-params]]
|
||||
|
|
|
@ -26,7 +26,7 @@ If the {es} {security-features} are enabled, you must have the following privile
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-evaluate-dfanalytics-desc]]
|
||||
|
|
|
@ -32,7 +32,7 @@ If the {es} {security-features} are enabled, you must have the following privile
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-explain-dfanalytics-desc]]
|
||||
|
|
|
@ -32,7 +32,7 @@ If the {es} {security-features} are enabled, you must have the following privile
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-dfanalytics-stats-path-params]]
|
||||
== {api-path-parms-title}
|
||||
|
|
|
@ -31,7 +31,7 @@ If the {es} {security-features} are enabled, you must have the following privile
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-get-dfanalytics-desc]]
|
||||
|
|
|
@ -32,9 +32,8 @@ experimental[]
|
|||
Required privileges which should be added to a custom role:
|
||||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-get-inference-stats-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -33,7 +33,7 @@ Required privileges which should be added to a custom role:
|
|||
|
||||
* cluster: `monitor_ml`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<security-privileges>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-get-inference-desc]]
|
||||
|
|
|
@ -23,14 +23,12 @@ experimental[]
|
|||
If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
|
||||
* source indices: `read`, `view_index_metadata`
|
||||
* destination index: `read`, `create_index`, `manage` and `index`
|
||||
* cluster: `monitor` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>>, <<security-privileges>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
NOTE: The {dfanalytics-job} remembers which roles the user who created it had at
|
||||
the time of creation. When you start the job, it performs the analysis using
|
||||
|
|
|
@ -28,11 +28,11 @@ experimental[]
|
|||
== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have the following
|
||||
built-in roles and privileges:
|
||||
built-in roles or equivalent privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-put-inference-desc]]
|
||||
|
|
|
@ -23,13 +23,11 @@ experimental[]
|
|||
If the {es} {security-features} are enabled, you must have the following built-in roles and privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
* source indices: `read`, `view_index_metadata`
|
||||
* destination index: `read`, `create_index`, `manage` and `index`
|
||||
* cluster: `monitor` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
|
||||
For more information, see <<built-in-roles>>, <<security-privileges>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
[[ml-start-dfanalytics-desc]]
|
||||
== {api-description-title}
|
||||
|
|
|
@ -27,9 +27,8 @@ experimental[]
|
|||
If the {es} {security-features} are enabled, you must have the following built-in roles or equivalent privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>> and {ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[ml-stop-dfanalytics-desc]]
|
||||
|
|
|
@ -24,14 +24,11 @@ If the {es} {security-features} are enabled, you must have the following
|
|||
built-in roles and privileges:
|
||||
|
||||
* `machine_learning_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
|
||||
* source indices: `read`, `view_index_metadata`
|
||||
* destination index: `read`, `create_index`, `manage` and `index`
|
||||
* cluster: `monitor` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>>, <<security-privileges>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
NOTE: The {dfanalytics-job} remembers which roles the user who created it had at
|
||||
the time of creation. When you start the job, it performs the analysis using
|
||||
|
|
|
@ -22,13 +22,11 @@ If the {es} {security-features} are enabled, you must have the following
|
|||
built-in roles and privileges:
|
||||
|
||||
* `transform_admin`
|
||||
* `kibana_admin` (UI only)
|
||||
|
||||
* source index: `read`, `view_index_metadata`
|
||||
* destination index: `read`, `create_index`, `manage` and `index`
|
||||
* cluster: `monitor` (UI only)
|
||||
|
||||
For more information, see <<security-privileges>> and <<built-in-roles>>.
|
||||
For more information, see <<built-in-roles>>, <<security-privileges>>, and
|
||||
{ml-docs-setup-privileges}.
|
||||
|
||||
|
||||
[[put-transform-desc]]
|
||||
|
|
|
@ -111,8 +111,7 @@ use of the {ml} APIs. Grants `manage_ml` cluster privileges, read access to
|
|||
`.ml-anomalies*`, `.ml-notifications*`, `.ml-state*`, `.ml-meta*` indices and
|
||||
write access to `.ml-annotations*` indices. {ml-cap} administrators also need
|
||||
index privileges for source and destination indices and roles that grant
|
||||
access to {kib}.
|
||||
See {ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges].
|
||||
access to {kib}. See {ml-docs-setup-privileges}.
|
||||
|
||||
[[built-in-roles-ml-user]] `machine_learning_user`::
|
||||
Grants the minimum privileges required to view {ml} configuration,
|
||||
|
@ -120,8 +119,7 @@ status, and work with results. This role grants `monitor_ml` cluster privileges,
|
|||
read access to the `.ml-notifications` and `.ml-anomalies*` indices
|
||||
(which store {ml} results), and write access to `.ml-annotations*` indices.
|
||||
{ml-cap} users also need index privileges for source and destination
|
||||
indices and roles that grant access to {kib}. See
|
||||
{ml-docs}/setup.html#setup-privileges[{ml-cap} security privileges].
|
||||
indices and roles that grant access to {kib}. See {ml-docs-setup-privileges}.
|
||||
|
||||
[[built-in-roles-monitoring-user]] `monitoring_user`::
|
||||
Grants the minimum privileges required for any user of {monitoring} other than those
|
||||
|
|
Loading…
Reference in New Issue