mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-30 03:48:54 +00:00
This commit is contained in:
parent
36121117f0
commit
b3d5300968
docs/reference
@ -972,12 +972,6 @@ end::time[]
|
|||||||
tag::timeoutparms[]
|
tag::timeoutparms[]
|
||||||
|
|
||||||
tag::timeout[]
|
tag::timeout[]
|
||||||
`timeout`::
|
|
||||||
(Optional, <<time-units, time units>>) Specifies the period of time to wait for
|
|
||||||
a response. If no response is received before the timeout expires, the request
|
|
||||||
fails and returns an error. Defaults to `30s`.
|
|
||||||
end::timeout[]
|
|
||||||
|
|
||||||
tag::master-timeout[]
|
tag::master-timeout[]
|
||||||
`master_timeout`::
|
`master_timeout`::
|
||||||
(Optional, <<time-units, time units>>) Specifies the period of time to wait for
|
(Optional, <<time-units, time units>>) Specifies the period of time to wait for
|
||||||
@ -985,6 +979,11 @@ a connection to the master node. If no response is received before the timeout
|
|||||||
expires, the request fails and returns an error. Defaults to `30s`.
|
expires, the request fails and returns an error. Defaults to `30s`.
|
||||||
end::master-timeout[]
|
end::master-timeout[]
|
||||||
|
|
||||||
|
`timeout`::
|
||||||
|
(Optional, <<time-units, time units>>) Specifies the period of time to wait for
|
||||||
|
a response. If no response is received before the timeout expires, the request
|
||||||
|
fails and returns an error. Defaults to `30s`.
|
||||||
|
end::timeout[]
|
||||||
end::timeoutparms[]
|
end::timeoutparms[]
|
||||||
|
|
||||||
tag::type[]
|
tag::type[]
|
||||||
|
@ -43,102 +43,71 @@ you want to create or update.
|
|||||||
|
|
||||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
|
|
||||||
|
[role="child_attributes"]
|
||||||
[[slm-api-put-request-body]]
|
[[slm-api-put-request-body]]
|
||||||
==== {api-request-body-title}
|
==== {api-request-body-title}
|
||||||
|
|
||||||
`schedule`::
|
|
||||||
(Required, <<schedule-cron,Cron scheduler configuration>>)
|
|
||||||
Periodic or absolute schedule
|
|
||||||
at which the policy creates snapshots
|
|
||||||
and deletes expired snapshots.
|
|
||||||
+
|
|
||||||
Schedule changes to existing policies
|
|
||||||
are applied immediately.
|
|
||||||
|
|
||||||
`name`::
|
|
||||||
+
|
|
||||||
--
|
|
||||||
(Required, string)
|
|
||||||
Name automatically assigned to each snapshot
|
|
||||||
created by the policy.
|
|
||||||
|
|
||||||
This value supports the same <<date-math-index-names,date math>>
|
|
||||||
supported in index names.
|
|
||||||
|
|
||||||
To prevent conflicting snapshot names,
|
|
||||||
a UUID is automatically appended to each snapshot name.
|
|
||||||
--
|
|
||||||
|
|
||||||
`repository`::
|
|
||||||
+
|
|
||||||
--
|
|
||||||
(Required, string)
|
|
||||||
Repository used to store snapshots
|
|
||||||
created by this policy.
|
|
||||||
|
|
||||||
This repository must exist prior to the policy's creation.
|
|
||||||
You can create a repository
|
|
||||||
using the <<modules-snapshots,snapshot repository API>>.
|
|
||||||
--
|
|
||||||
|
|
||||||
`config`::
|
`config`::
|
||||||
+
|
|
||||||
--
|
|
||||||
(Required, object)
|
(Required, object)
|
||||||
Configuration for each snapshot
|
Configuration for each snapshot created by the policy.
|
||||||
created by the policy.
|
+
|
||||||
|
.Properties of `config`
|
||||||
Parameters include:
|
[%collapsible%open]
|
||||||
|
====
|
||||||
`indices`::
|
|
||||||
(Optional, array of strings)
|
|
||||||
Array of index names or wildcard pattern of index names
|
|
||||||
included in snapshots.
|
|
||||||
|
|
||||||
`ignore_unavailable`::
|
`ignore_unavailable`::
|
||||||
(Optional, boolean)
|
(Optional, boolean)
|
||||||
If `true`,
|
If `true`, missing indices do *not* cause snapshot creation to fail and return
|
||||||
missing indices do *not* cause snapshot creation to fail
|
an error. Defaults to `false`.
|
||||||
and return an error.
|
|
||||||
Defaults to `false`.
|
|
||||||
|
|
||||||
`include_global_state`::
|
`include_global_state`::
|
||||||
(Optional, boolean)
|
(Optional, boolean)
|
||||||
If `true`,
|
If `true`, cluster states are included in snapshots. Defaults to `false`.
|
||||||
cluster states are included in snapshots.
|
|
||||||
Defaults to `false`.
|
`indices`::
|
||||||
--
|
(Optional, array of strings)
|
||||||
|
Array of index names or wildcard pattern of index names included in snapshots.
|
||||||
|
====
|
||||||
|
|
||||||
|
`name`::
|
||||||
|
(Required, string)
|
||||||
|
Name automatically assigned to each snapshot created by the policy. This value
|
||||||
|
supports the same <<date-math-index-names,date math>> supported in index names.
|
||||||
|
To prevent conflicting snapshot names, a UUID is automatically appended to each
|
||||||
|
snapshot name.
|
||||||
|
|
||||||
|
`repository`::
|
||||||
|
(Required, string)
|
||||||
|
Repository used to store snapshots created by this policy. This repository must
|
||||||
|
exist prior to the policy's creation. You can create a repository using the
|
||||||
|
<<modules-snapshots,snapshot repository API>>.
|
||||||
|
|
||||||
`retention`::
|
`retention`::
|
||||||
+
|
|
||||||
--
|
|
||||||
(Optional, object)
|
(Optional, object)
|
||||||
Retention rules used to retain
|
Retention rules used to retain and delete snapshots created by the policy.
|
||||||
and delete snapshots
|
+
|
||||||
created by the policy.
|
.Properties of `retention`
|
||||||
|
[%collapsible%open]
|
||||||
Parameters include:
|
====
|
||||||
|
|
||||||
`expire_after`::
|
`expire_after`::
|
||||||
(Optional, <<time-units, time units>>)
|
(Optional, <<time-units, time units>>)
|
||||||
Time period after which
|
Time period after which a snapshot is considered expired and eligible for
|
||||||
a snapshot is considered expired
|
deletion.
|
||||||
and eligible for deletion.
|
|
||||||
|
|
||||||
`max_count`::
|
`max_count`::
|
||||||
(Optional, integer)
|
(Optional, integer)
|
||||||
Maximum number of snapshots to retain,
|
Maximum number of snapshots to retain, even if the snapshots have not yet
|
||||||
even if the snapshots have not yet expired.
|
expired. If the number of snapshots in the repository exceeds this limit, the
|
||||||
+
|
policy retains the most recent snapshots and deletes older snapshots.
|
||||||
If the number of snapshots in the repository exceeds this limit,
|
|
||||||
the policy retains the most recent snapshots
|
|
||||||
and deletes older snapshots.
|
|
||||||
|
|
||||||
`min_count`::
|
`min_count`::
|
||||||
(Optional, integer)
|
(Optional, integer)
|
||||||
Minimum number of snapshots to retain,
|
Minimum number of snapshots to retain, even if the snapshots have expired.
|
||||||
even if the snapshots have expired.
|
====
|
||||||
--
|
|
||||||
|
`schedule`::
|
||||||
|
(Required, <<schedule-cron,Cron scheduler configuration>>)
|
||||||
|
Periodic or absolute schedule at which the policy creates snapshots and deletes
|
||||||
|
expired snapshots. Schedule changes to existing policies are applied immediately.
|
||||||
|
|
||||||
[[slm-api-put-example]]
|
[[slm-api-put-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user