开启或修改集群快照功能

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

bucket

是

String

参数解释：

存储快照的OBS桶名称。

约束限制：

• 存储类别必须是标准存储。

• 区域必须与集群所在区域相同。

取值范围：

不涉及

默认取值：

不涉及

agency

是

String

参数解释：

委托名称，选择IAM委托，授权当前账号访问和使用OBS的权限。快照数据存储到OBS桶中，需要OBS的操作权限。

约束限制：

委托名称必须仅包含字符a-z、A-Z、0-9、下划线（_）和短横线（-），否则会备份失败。

取值范围：

不涉及

默认取值：

不涉及

base_path

否

String

参数解释：

快照在OBS桶中的存放路径。

约束限制：

不涉及

取值范围：

• 备份路径不能包括下列符号 ：\:*?"<>|'{}

• 备份路径不能以“/”开头

• 备份路径不能以“.”开头或结尾

• 备份路径不能包含两个以上连续的斜杆（/）或点（.）

• 备份路径的总长度不能超过512字符

默认取值：

不涉及

max_snapshot_bytes_per_seconds

否

String

参数解释：

配置每个节点的最大备份速率（每秒），即当备份的速率超过该值时会被限流，避免速率太大导致资源占用过高，影响系统稳定性。实际备份速率不一定能达到该值，会受OBS、磁盘等影响。

约束限制：

不涉及

取值范围：

有以下3种填写规则：

• 数字+单位

• 0

• -1

数字部分支持0~9999。

单位部分支持k、kb、m、mb、g、gb、t、tb、p、pb、b，且不区分大小写。

当填写0mb、0或-1时，表示不限速，当备份速率过大时，可能导致备份占用资源过高，影响系统稳定性。

默认取值：

默认值是40MB，不填写时表示使用默认值。

max_restore_bytes_per_seconds

否

String

参数解释：

配置每个节点的最大恢复速率（每秒），即当恢复的速率超过该值时会被限流，避免速率太大导致资源占用过高，影响系统稳定性。实际恢复速率不一定能达到该值，会受OBS、磁盘等影响。

约束限制：

OpenSearch集群和版本高于7.6.2的Elasticsearch集群，恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数。当“最大恢复速率（每秒）”小于“indices.recovery.max_bytes_per_sec”的参数值时，恢复速率达到“最大恢复速率（每秒）”参数值时就会被限流。当“最大恢复速率（每秒）”大于“indices.recovery.max_bytes_per_sec”的参数值时，恢复速率达到“indices.recovery.max_bytes_per_sec”参数值时就会被限流。

取值范围：

有以下3种填写规则：

• 数字+单位

• 0

• -1

数字部分支持0~9999。

单位部分支持k、kb、m、mb、g、gb、t、tb、p、pb、b，且不区分大小写。

当填写0mb、0或-1时，表示不限速（但OpenSearch集群和版本高于7.6.2的Elasticsearch集群，恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数），当恢复速率过大时，可能导致恢复占用资源过高，影响系统稳定性。

默认取值：

7.6.2及以下版本的Elasticsearch集群，默认值是40MB。

OpenSearch集群和7.6.2以上版本的Elasticsearch集群，默认值是不限制，但还受限于“indices.recovery.max_bytes_per_sec”参数。

不填写时表示使用默认值。

enable

否

String

参数解释：

是否开启自动创建快照功能。

约束限制：

不涉及

取值范围：

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

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

默认取值：

false

indices

否

String

参数解释：

需要备份的索引名。

• 支持指定索引，多个索引之间使用英文逗号隔开，例如“index1,index2,index3”。

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

约束限制：

enable为true时有效。

取值范围：

支持0~1024个字符，不能包含大写字母、空格以及字符:"<|>/?

默认取值：

默认为空，表示备份全部索引。

prefix

否

String

参数解释：

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

约束限制：

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

取值范围：

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

默认取值：

不涉及

period

否

String

参数解释：

每天创建快照的时刻。

约束限制：

• frequency取值HOUR无需指定period值，默认从设置成功的下一整点创建。

取值范围：

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

默认取值：

00:00 GMT+08:00

keepday

否

Integer

参数解释：

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

约束限制：

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

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

取值范围：

1～90

默认取值：

不涉及

frequency

否

String

参数解释：

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

约束限制：

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

取值范围：

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

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

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

默认取值：

DAY

delete_auto

否

String

参数解释：

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

约束限制：

只有在enable参数为false时才生效。

取值范围：

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

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

默认取值：

false

200

请求成功。

406

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

412

未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。

504

网关超时。