This commit removes the documentation for some specific Searchable Snapshot REST APIs: - clear cache - searchable snapshot stats - repository stats These APIs are low-level and are useful to investigate the behavior of snapshot backed indices but we expect them to be removed in the future or to appear in a different form.
This commit is contained in:
Tanguy Leroux
GitHub
parent
7b941a18e9
commit
42f5d38d9b
|
|
@ -33,9 +33,7 @@ endif::[]
|
|||
* <<repositories-metering-apis,Repositories Metering APIs>>
|
||||
* <<rollup-apis,Rollup APIs>>
|
||||
* <<search, Search APIs>>
|
||||
ifdef::permanently-unreleased-branch[]
|
||||
* <<searchable-snapshots-apis, Searchable snapshots APIs>>
|
||||
endif::[]
|
||||
* <<security-api,Security APIs>>
|
||||
* <<snapshot-restore-apis,Snapshot and restore APIs>>
|
||||
* <<snapshot-lifecycle-management-api,Snapshot lifecycle management APIs>>
|
||||
|
|
|
|||
|
|
@ -1,76 +0,0 @@
|
|||
[role="xpack"]
|
||||
[testenv="enterprise"]
|
||||
[[searchable-snapshots-api-clear-cache]]
|
||||
=== Clear cache API
|
||||
++++
|
||||
<titleabbrev>Clear cache</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[]
|
||||
|
||||
Clear the cache of searchable snapshots.
|
||||
|
||||
[[searchable-snapshots-api-clear-cache-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`POST /_searchable_snapshots/cache/clear`
|
||||
|
||||
`POST /<target>/_searchable_snapshots/cache/clear`
|
||||
|
||||
[[searchable-snapshots-api-clear-cache-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have the
|
||||
`manage` cluster privilege and the `manage` index privilege
|
||||
for any included indices to use this API.
|
||||
For more information, see <<security-privileges>>.
|
||||
|
||||
[[searchable-snapshots-api-clear-cache-desc]]
|
||||
==== {api-description-title}
|
||||
|
||||
|
||||
[[searchable-snapshots-api-clear-cache-path-params]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<target>`::
|
||||
(Optional, string)
|
||||
A comma-separated list of data streams and indices for which the
|
||||
searchable snapshots cache must be cleared.
|
||||
|
||||
|
||||
[[searchable-snapshots-api-clear-cache-example]]
|
||||
==== {api-examples-title}
|
||||
////
|
||||
[source,console]
|
||||
-----------------------------------
|
||||
PUT /docs
|
||||
{
|
||||
"settings" : {
|
||||
"index.number_of_shards" : 1,
|
||||
"index.number_of_replicas" : 0
|
||||
}
|
||||
}
|
||||
|
||||
PUT /_snapshot/my_repository/my_snapshot?wait_for_completion=true
|
||||
{
|
||||
"include_global_state": false,
|
||||
"indices": "docs"
|
||||
}
|
||||
|
||||
DELETE /docs
|
||||
|
||||
POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
|
||||
{
|
||||
"index": "docs"
|
||||
}
|
||||
-----------------------------------
|
||||
// TEST[setup:setup-repository]
|
||||
////
|
||||
|
||||
Clears the cache of the index `docs`:
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
POST /docs/_searchable_snapshots/cache/clear
|
||||
--------------------------------------------------
|
||||
// TEST[continued]
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
[role="xpack"]
|
||||
[testenv="enterprise"]
|
||||
[[searchable-snapshots-api-stats]]
|
||||
=== Searchable snapshot statistics API
|
||||
++++
|
||||
<titleabbrev>Searchable snapshot statistics</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[]
|
||||
|
||||
Retrieve various statistics about searchable snapshots.
|
||||
|
||||
[[searchable-snapshots-api-stats-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`GET /_searchable_snapshots/stats`
|
||||
|
||||
`GET /<target>/_searchable_snapshots/stats`
|
||||
|
||||
[[searchable-snapshots-api-stats-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have the
|
||||
`manage` cluster privilege and the `manage` index privilege
|
||||
for any included indices to use this API.
|
||||
For more information, see <<security-privileges>>.
|
||||
|
||||
[[searchable-snapshots-api-stats-desc]]
|
||||
==== {api-description-title}
|
||||
|
||||
|
||||
[[searchable-snapshots-api-stats-path-params]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<target>`::
|
||||
(Optional, string)
|
||||
A comma-separated list of data streams and indices for which the
|
||||
statistics must be retrieved.
|
||||
|
||||
|
||||
[[searchable-snapshots-api-stats-example]]
|
||||
==== {api-examples-title}
|
||||
////
|
||||
[source,console]
|
||||
-----------------------------------
|
||||
PUT /docs
|
||||
{
|
||||
"settings" : {
|
||||
"index.number_of_shards" : 1,
|
||||
"index.number_of_replicas" : 0
|
||||
}
|
||||
}
|
||||
|
||||
PUT /_snapshot/my_repository/my_snapshot?wait_for_completion=true
|
||||
{
|
||||
"include_global_state": false,
|
||||
"indices": "docs"
|
||||
}
|
||||
|
||||
DELETE /docs
|
||||
|
||||
POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
|
||||
{
|
||||
"index": "docs"
|
||||
}
|
||||
-----------------------------------
|
||||
// TEST[setup:setup-repository]
|
||||
////
|
||||
|
||||
Retrieves the statistics of the index `docs`:
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
GET /docs/_searchable_snapshots/stats
|
||||
--------------------------------------------------
|
||||
// TEST[continued]
|
||||
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
experimental[]
|
||||
|
||||
Mount a snapshot as a searchable index.
|
||||
Mount a snapshot as a snapshot backed index.
|
||||
|
||||
[[searchable-snapshots-api-mount-request]]
|
||||
==== {api-request-title}
|
||||
|
|
|
|||
|
|
@ -1,73 +0,0 @@
|
|||
[role="xpack"]
|
||||
[testenv="enterprise"]
|
||||
[[searchable-snapshots-repository-stats]]
|
||||
=== Searchable snapshot repository statistics API
|
||||
++++
|
||||
<titleabbrev>Searchable snapshot repository statistics</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[]
|
||||
|
||||
Retrieve usage statistics about a snapshot repository.
|
||||
|
||||
[[searchable-snapshots-repository-stats-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`GET /_snapshot/<repository>/_stats`
|
||||
|
||||
[[searchable-snapshots-repository-stats-prereqs]]
|
||||
==== {api-prereq-title}
|
||||
|
||||
If the {es} {security-features} are enabled, you must have the
|
||||
`manage` cluster privilege and the `manage` index privilege
|
||||
for any included indices to use this API.
|
||||
For more information, see <<security-privileges>>.
|
||||
|
||||
[[searchable-snapshots-repository-stats-desc]]
|
||||
==== {api-description-title}
|
||||
|
||||
|
||||
[[searchable-snapshots-repository-stats-path-params]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<repository>`::
|
||||
(Required, string)
|
||||
The repository for which to retrieve stats.
|
||||
|
||||
|
||||
[[searchable-snapshots-repository-stats-example]]
|
||||
==== {api-examples-title}
|
||||
////
|
||||
[source,console]
|
||||
-----------------------------------
|
||||
PUT /docs
|
||||
{
|
||||
"settings" : {
|
||||
"index.number_of_shards" : 1,
|
||||
"index.number_of_replicas" : 0
|
||||
}
|
||||
}
|
||||
|
||||
PUT /_snapshot/my_repository/my_snapshot?wait_for_completion=true
|
||||
{
|
||||
"include_global_state": false,
|
||||
"indices": "docs"
|
||||
}
|
||||
|
||||
DELETE /docs
|
||||
|
||||
POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
|
||||
{
|
||||
"index": "docs"
|
||||
}
|
||||
-----------------------------------
|
||||
// TEST[setup:setup-repository]
|
||||
////
|
||||
|
||||
Retrieves the statistics of the repository `my_repository`:
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
GET /_snapshot/my_repository/_stats
|
||||
--------------------------------------------------
|
||||
// TEST[continued]
|
||||
|
|
@ -8,11 +8,5 @@ experimental[]
|
|||
You can use the following APIs to perform searchable snapshots operations.
|
||||
|
||||
* <<searchable-snapshots-api-mount-snapshot,Mount snapshot>>
|
||||
* <<searchable-snapshots-api-clear-cache,Clear cache>>
|
||||
* <<searchable-snapshots-api-stats,Get stats>>
|
||||
* <<searchable-snapshots-repository-stats,Repository stats>>
|
||||
|
||||
include::mount-snapshot.asciidoc[]
|
||||
include::clear-cache.asciidoc[]
|
||||
include::get-stats.asciidoc[]
|
||||
include::repository-stats.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"searchable_snapshots.clear_cache": {
|
||||
"documentation": {
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-clear-cache.html",
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html",
|
||||
"description" : "Clear the cache of searchable snapshots."
|
||||
},
|
||||
"stability": "experimental",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"searchable_snapshots.repository_stats": {
|
||||
"documentation": {
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-repository-stats.html",
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html",
|
||||
"description": "Retrieve usage statistics about a snapshot repository."
|
||||
},
|
||||
"stability": "experimental",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"searchable_snapshots.stats": {
|
||||
"documentation": {
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-stats.html",
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html",
|
||||
"description": "Retrieve various statistics about searchable snapshots."
|
||||
},
|
||||
"stability": "experimental",
|
||||
|
|
|
|||
Loading…
Reference in New Issue