查询自动创建快照的策略

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster_id

是

String

参数解释：

指定需查询自动创建快照策略的集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及

取值范围：

集群ID。

默认取值：

不涉及

keepday

Integer

参数解释：

自定义设置快照保留的个数。

取值范围：

不涉及

period

String

参数解释：

每天快照创建的具体时刻。

取值范围：

不涉及

frequency

String

参数解释：

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

取值范围：

• DAY：表示天。

• HOUR：表示小时。

• MON：表示周一。

• TUE：表示周二。

• WED：表示周三。

• THU：表示周四。

• FRI：表示周五。

• SAT：表示周六。

• SUN：表示周日。

prefix

String

参数解释：

快照命名前缀，需要用户自己手动输入。

取值范围：

不涉及

bucket

String

参数解释：

快照存放的OBS桶的桶名。

取值范围：

不涉及

basePath

String

参数解释：

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

取值范围：

不涉及

agency

String

参数解释：

委托名称，委托给CSS，允许CSS调用您的其他云服务。无法配置含特殊字符和中文字符的委托。

取值范围：

允许使用的委托名称仅可包含a-zA-Z0-9-_字符。

enable

String

参数解释：

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

取值范围：

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

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

indices

String

参数解释：

指定要备份的索引名称，多个索引用逗号隔开，默认备份所有索引。支持使用“*”匹配多个索引，例如：2018-06*，表示备份名称前缀是2018-06的所有索引的数据。

取值范围：

0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?特殊字符。

snapshotCmkId

String

参数解释：

快照ID。

取值范围：

不涉及

maxSnapshotBytesPerSeconds

String

参数解释：

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

取值范围：

有以下3种填写规则：

• 数字+单位

  数字部分支持0~9999。

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

  当填写0mb时，表示不限速，当备份速率过大时，可能导致备份占用资源过高，影响系统稳定性，请谨慎配置该值。

• 0

  表示不限速，当备份速率过大时，可能导致备份占用资源过高，影响系统稳定性，请谨慎配置该值。

• -1

  表示不限速，当备份速率过大时，可能导致备份占用资源过高，影响系统稳定性，请谨慎配置该值。

maxRestoreBytesPerSeconds

String

参数解释：

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

取值范围：

有以下3种填写规则：

• 数字+单位

  数字部分支持0~9999。

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

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

• 0

  表示不限速（但OpenSearch集群和7.6.2以上版本的Elasticsearch集群，恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数），当恢复速率过大时，可能导致恢复占用资源过高，影响系统稳定性，请谨慎配置该值。

• -1

  表示不限速（但OpenSearch集群和7.6.2以上版本的Elasticsearch集群，恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数），当恢复速率过大时，可能导致恢复占用资源过高，影响系统稳定性，请谨慎配置该值。

200

请求已成功。

406

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