[DOCS] Add security privileges to cat API docs (#67467) (#67772)

This commit is contained in:
James Rodewig 2021-01-20 10:46:42 -05:00 committed by GitHub
parent bd955fbc91
commit 1969ed7e67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 115 additions and 2 deletions

View File

@ -15,6 +15,13 @@ filter and routing information.
`GET /_cat/aliases` `GET /_cat/aliases`
[[cat-alias-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the
`view_index_metadata` or `manage` <<privileges-list-indices,index privilege>>
for any alias you retrieve.
[[cat-alias-api-path-params]] [[cat-alias-api-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -16,6 +16,12 @@ and their disk space.
`GET /_cat/allocation` `GET /_cat/allocation`
[[cat-allocation-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-allocation-api-path-params]] [[cat-allocation-api-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -18,6 +18,12 @@ which have not yet been removed by the merge process.
`GET /_cat/count` `GET /_cat/count`
[[cat-count-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `read`
<<privileges-list-indices,index privilege>> for any data stream, index, or index
alias you retrieve.
[[cat-count-api-path-params]] [[cat-count-api-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -15,6 +15,11 @@ Returns the amount of heap memory currently used by the
`GET /_cat/fielddata` `GET /_cat/fielddata`
[[cat-fielddata-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-fielddata-api-path-params]] [[cat-fielddata-api-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -13,6 +13,11 @@ health>> API.
`GET /_cat/health` `GET /_cat/health`
[[cat-health-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-health-api-desc]] [[cat-health-api-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -15,6 +15,13 @@ indices for data streams.
`GET /_cat/indices` `GET /_cat/indices`
[[cat-indices-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
[[cat-indices-api-desc]] [[cat-indices-api-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -13,6 +13,11 @@ and name.
`GET /_cat/master` `GET /_cat/master`
[[cat-master-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-master-api-query-params]] [[cat-master-api-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}

View File

@ -11,6 +11,12 @@ Returns information about custom node attributes.
`GET /_cat/nodeattrs` `GET /_cat/nodeattrs`
[[cat-nodeattrs-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-nodeattrs-api-query-params]] [[cat-nodeattrs-api-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}

View File

@ -11,6 +11,12 @@ Returns information about a cluster's nodes.
`GET /_cat/nodes` `GET /_cat/nodes`
[[cat-nodes-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-nodes-api-query-params]] [[cat-nodes-api-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}

View File

@ -12,6 +12,12 @@ Returns cluster-level changes that have not yet been executed, similar to the
`GET /_cat/pending_tasks` `GET /_cat/pending_tasks`
[[cat-pending-tasks-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-pending-tasks-api-query-params]] [[cat-pending-tasks-api-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}

View File

@ -7,13 +7,18 @@
Returns a list of plugins running on each node of a cluster. Returns a list of plugins running on each node of a cluster.
[[cat-plugins-tasks-api-request]] [[cat-plugins-api-request]]
==== {api-request-title} ==== {api-request-title}
`GET /_cat/plugins` `GET /_cat/plugins`
[[cat-plugins-api-prereqs]]
==== {api-prereq-title}
[[cat-plugins-tasks-api-query-params]] * If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-plugins-api-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]

View File

@ -18,6 +18,13 @@ indices.
`GET /_cat/recovery` `GET /_cat/recovery`
[[cat-recovery-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
[[cat-recovery-api-desc]] [[cat-recovery-api-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -12,6 +12,12 @@ Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.
`GET /_cat/repositories` `GET /_cat/repositories`
[[cat-repositories-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the
`monitor_snapshot`, `create_snapshot`, or `manage`
<<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-repositories-query-params]] [[cat-repositories-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}

View File

@ -18,6 +18,13 @@ indices.
`GET /_cat/segments` `GET /_cat/segments`
[[cat-segments-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
[[cat-segments-path-params]] [[cat-segments-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -19,6 +19,13 @@ indices.
`GET /_cat/shards` `GET /_cat/shards`
[[cat-shards-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
[[cat-shards-path-params]] [[cat-shards-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -13,6 +13,13 @@ more repositories. A snapshot is a backup of an index or running {es} cluster.
`GET /_cat/snapshots/<repository>` `GET /_cat/snapshots/<repository>`
[[cat-snapshots-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the
`monitor_snapshot`, `create_snapshot`, or `manage`
<<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-snapshots-path-params]] [[cat-snapshots-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -15,6 +15,11 @@ similar to the <<tasks,task management>> API.
`GET /_cat/tasks` `GET /_cat/tasks`
[[cat-tasks-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-tasks-api-desc]] [[cat-tasks-api-desc]]
==== {api-description-title} ==== {api-description-title}

View File

@ -16,6 +16,11 @@ and <<mapping,field mappings>> to new indices at creation.
`GET /_cat/templates` `GET /_cat/templates`
[[cat-templates-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-templates-path-params]] [[cat-templates-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}

View File

@ -16,6 +16,11 @@ pools.
`GET /_cat/thread_pool` `GET /_cat/thread_pool`
[[cat-thread-pool-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
[[cat-thread-pool-path-params]] [[cat-thread-pool-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}