[DOCS] Collapses sections in put snapshot lifecycle policy API (#54834) (#54840)

This commit is contained in:
Lisa Cawley 2020-04-06 13:46:56 -07:00 committed by GitHub
parent 36121117f0
commit b3d5300968
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 49 additions and 81 deletions

View File

@ -972,12 +972,6 @@ end::time[]
tag::timeoutparms[]
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[]
`master_timeout`::
(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`.
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[]
tag::type[]

View File

@ -43,102 +43,71 @@ you want to create or update.
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[role="child_attributes"]
[[slm-api-put-request-body]]
==== {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`::
+
--
(Required, object)
Configuration for each snapshot
created by the policy.
Parameters include:
`indices`::
(Optional, array of strings)
Array of index names or wildcard pattern of index names
included in snapshots.
Configuration for each snapshot created by the policy.
+
.Properties of `config`
[%collapsible%open]
====
`ignore_unavailable`::
(Optional, boolean)
If `true`,
missing indices do *not* cause snapshot creation to fail
and return an error.
Defaults to `false`.
If `true`, missing indices do *not* cause snapshot creation to fail and return
an error. Defaults to `false`.
`include_global_state`::
(Optional, boolean)
If `true`,
cluster states are included in snapshots.
Defaults to `false`.
--
If `true`, 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`::
+
--
(Optional, object)
Retention rules used to retain
and delete snapshots
created by the policy.
Parameters include:
Retention rules used to retain and delete snapshots created by the policy.
+
.Properties of `retention`
[%collapsible%open]
====
`expire_after`::
(Optional, <<time-units, time units>>)
Time period after which
a snapshot is considered expired
and eligible for deletion.
Time period after which a snapshot is considered expired and eligible for
deletion.
`max_count`::
(Optional, integer)
Maximum number of snapshots to retain,
even if the snapshots have not yet expired.
+
If the number of snapshots in the repository exceeds this limit,
the policy retains the most recent snapshots
and deletes older snapshots.
Maximum number of snapshots to retain, even if the snapshots have not yet
expired. If the number of snapshots in the repository exceeds this limit, the
policy retains the most recent snapshots and deletes older snapshots.
`min_count`::
(Optional, integer)
Minimum number of snapshots to retain,
even if the snapshots have expired.
--
Minimum number of snapshots to retain, 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]]
==== {api-examples-title}