mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-17 10:25:15 +00:00
[DOCS] Add delete index alias API docs (#46080)
This commit is contained in:
parent
ab045744ac
commit
f77aed8ea9
@ -35,6 +35,7 @@ index settings, aliases, mappings, and index templates.
|
|||||||
[[alias-management]]
|
[[alias-management]]
|
||||||
=== Alias management:
|
=== Alias management:
|
||||||
* <<indices-add-alias>>
|
* <<indices-add-alias>>
|
||||||
|
* <<indices-delete-alias>>
|
||||||
* <<indices-get-alias>>
|
* <<indices-get-alias>>
|
||||||
* <<indices-alias-exists>>
|
* <<indices-alias-exists>>
|
||||||
* <<indices-aliases>>
|
* <<indices-aliases>>
|
||||||
@ -103,6 +104,8 @@ include::indices/types-exists.asciidoc[]
|
|||||||
|
|
||||||
include::indices/add-alias.asciidoc[]
|
include::indices/add-alias.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/delete-alias.asciidoc[]
|
||||||
|
|
||||||
include::indices/get-alias.asciidoc[]
|
include::indices/get-alias.asciidoc[]
|
||||||
|
|
||||||
include::indices/alias-exists.asciidoc[]
|
include::indices/alias-exists.asciidoc[]
|
||||||
|
49
docs/reference/indices/delete-alias.asciidoc
Normal file
49
docs/reference/indices/delete-alias.asciidoc
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
[[indices-delete-alias]]
|
||||||
|
=== Delete index alias API
|
||||||
|
++++
|
||||||
|
<titleabbrev>Delete index alias</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
|
Deletes an existing index alias.
|
||||||
|
|
||||||
|
include::alias-exists.asciidoc[tag=index-alias-def]
|
||||||
|
|
||||||
|
[source,js]
|
||||||
|
----
|
||||||
|
DELETE /twitter/_alias/alias1
|
||||||
|
----
|
||||||
|
// CONSOLE
|
||||||
|
// TEST[setup:twitter]
|
||||||
|
// TEST[s/^/PUT twitter\/_alias\/alias1\n/]
|
||||||
|
|
||||||
|
[[delete-alias-api-request]]
|
||||||
|
==== {api-request-title}
|
||||||
|
|
||||||
|
`DELETE /<index>/_alias/<alias>`
|
||||||
|
|
||||||
|
`DELETE /<index>/_aliases/<alias>`
|
||||||
|
|
||||||
|
|
||||||
|
[[delete-alias-api-path-params]]
|
||||||
|
==== {api-path-parms-title}
|
||||||
|
|
||||||
|
`<index>`::
|
||||||
|
(Required, string)
|
||||||
|
Comma-separated list or wildcard expression of index names
|
||||||
|
used to limit the request.
|
||||||
|
+
|
||||||
|
To include all indices in the cluster,
|
||||||
|
use a value of `_all` or `*`.
|
||||||
|
|
||||||
|
`<alias>`::
|
||||||
|
(Required, string)
|
||||||
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias]
|
||||||
|
+
|
||||||
|
To delete all aliases,
|
||||||
|
use a value of `_all` or `*`.
|
||||||
|
|
||||||
|
|
||||||
|
[[delete-alias-api-query-params]]
|
||||||
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
Loading…
x
Reference in New Issue
Block a user