开启自动创建快照功能
功能介绍
该接口用于开启集群的自动创建快照功能，通过快照备份将集群的数据状态保存到OBS桶中，以便在需要时进行数据恢复。
自动创建快照可以按照预设的时间策略自动执行快照备份操作，适合定期备份场景，例如每日或每周备份，以确保数据的持续保护。
仅Elasticsearch和OpenSearch集群支持开启自动创建快照功能。
调用方法
请参见如何调用API。
URI
POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/open
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
indices |
否 |
String |
参数解释： 指定要备份的索引名称。
约束限制： 不涉及 取值范围： 支持0~1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?特殊字符。 默认取值： 默认为空，表示备份全部索引。 |
|
keepday |
是 |
Integer |
参数解释： 自定义设置快照保留的个数，系统在半点时刻会自动删除超过保留个数的快照。过期删除策略只针对与当前自动创建快照策略相同执行频次的自动快照。 约束限制： 保存快照个数与自动创建快照策略中设置的执行频次和索引有关，当执行频次间隔时间短或索引数据量大，保留自动快照可能会达不到设置的个数。 取值范围： 1~90 默认取值： 不涉及 |
|
frequency |
否 |
String |
参数解释： 自动创建快照的执行频次。 约束限制： 不涉及 取值范围：
默认取值： DAY |
|
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 |
|
prefix |
是 |
String |
参数解释： 自动创建快照的名称前缀。快照名称由快照名称前缀加上时间戳组成，例如“snapshot-1566921603720”。 约束限制： 不涉及 取值范围： 只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。 默认取值： 不涉及 |
响应参数
状态码：200
请求已成功。
无
请求示例
打开自动备份功能，自动备份的快照保存7个，每天16点自动支持备份操作，创建的快照名称前缀是snapshot.XXXX
POST https://{Endpoint}/v2.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/open
{
"indices" : "*",
"keepday" : 7,
"frequency" : "DAY",
"period" : "16:00 GMT+08:00",
"prefix" : "snapshot"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求，不要重试该请求。 |
|
403 |
请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
