设置自动创建快照策略

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定设置自动创建快照的集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

indices

否

String

参数解释：

需要备份的索引名。

约束限制：

• 支持使用“*”匹配多个索引，比如index*，表示恢复快照中名称前缀是index的所有索引。

• 支持指定索引，比如”index1,index2,index3“。

• 使用“*”匹配索引时，默认会过滤掉“.opendistro_security”或以“.kibana”为前缀的系统索引。“.opendistro_security”索引不允许恢复，恢复以“.kibana”为前缀的索引时需要指定索引名称。

取值范围：

• 支持使用“*”匹配多个索引，比如index*，表示备份名称前缀是index的所有索引。

• 备份指定索引：比如“index1"、“index2”、“Index3”。

• 不能包含大写字母、空格以及字符:"<|>/?

• 允许的最大字符数为1024

默认取值：

默认为空，表示将创建集群全部索引的快照。

prefix

否

String

参数解释：

自动创建快照的名称前缀。快照名称由快照名称前缀加上时间戳组成，例如“snapshot-1566921603720”。

约束限制：

当enable为true时该字段为必选字段。

取值范围：

只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。

默认取值：

不涉及

period

否

String

参数解释：

每天创建快照的时刻，只支持整点，后面需加上时区，格式为HH:mm z，HH:mm表示整点时间，z表示时区。 比如00:00 GMT+08:00、01:00 GMT+08:00等。

约束限制：

当frequency取值HOUR时，无需指定period值，默认从设置成功的下一整点创建。当enable为true时该字段为必选字段。

取值范围：

不涉及

默认取值：

00:00 GMT+08:00

keepday

否

Integer

参数解释：

自定义设置快照保留的个数。系统在半点时刻会自动删除超过保留个数的快照。过期删除策略只针对与当前自动创建快照策略相同执行频次的自动快照。

约束限制：

• 保存快照个数与自动创建快照策略中设置的执行频次和索引有关，当执行频次间隔时间短或索引数据量大，保留自动快照可能会达不到设置的个数。

• 当enable为true时该字段为必选字段。

取值范围：

1～90

默认取值：

不涉及

enable

是

String

参数解释：

是否开启自动创建快照策略。

约束限制：

不涉及

取值范围：

• true：表示开启自动创建快照策略。

• false：表示关闭自动创建快照策略。

默认取值：

不涉及

delete_auto

否

String

参数解释：

表示关闭自动创建快照时，是否需要清除所有自动创建的快照。

约束限制：

关闭自动创建快照时，如果未同步删除自动创建的快照，在重启自动创建快照功能时，集群中所有的自动创建的快照都无法被手动删除，只能随当前的备份策略被系统删除。

取值范围：

• true：表示在关闭自动创建快照时，删除所有自动创建的快照。

• false：表示不会删除自动创建的快照。

默认取值：

false

frequency

否

String

参数解释：

自动创建快照的执行频次。

约束限制：

保留快照个数与自动创建快照策略中设置的执行频次和索引有关。当执行频次间隔时间短或索引数据量大，保留自动快照可能会达不到设置的个数。

取值范围：

• HOUR：表示每小时整点执行一次。

• DAY：表示每天执行一次。

• SUN、MON、TUE、WED、THU、FRI、SAT：表示在每周对应时间执行一次。比如SUN表示每周日执行一次。

默认取值：

DAY

200

请求已成功。

406

服务器无法根据客户端请求的内容特性完成请求。