设置自动创建快照策略
功能介绍
该接口用于设置自动创建快照，默认一天创建一个快照。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID和名称。 |
cluster_id |
是 |
String |
指定要自动创建快照的集群ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
indices |
否 |
String |
需要备份的索引名。*代表所有索引。 |
prefix |
否 |
String |
自动创建快照的名称前缀，需要用户自己手动输入。 只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。 说明：
当enable为true时该字段为必选字段。 |
period |
否 |
String |
每天创建快照的时刻，只支持整点，后面需加上时区，格式为“HH:mm z”，“HH:mm”表示整点时间，“z”表示时区。 比如“00:00 GMT+08:00”、“01:00 GMT+08:00”等。 说明：
默认值“00:00 GMT+08:00”，当frequency取值HOUR时，无需指定period值，默认从设置成功的下一整点创建。当enable为true时该字段为必选字段。 |
keepday |
否 |
Integer |
自定义设置快照保留的个数，范围是1～90。系统在半点时刻会自动删除超过保留个数的快照。过期删除策略只针对与当前自动创建快照策略相同执行频次的自动快照。 说明：
当enable为true时该字段为必选字段。 |
enable |
是 |
String |
是否开启自动创建快照策略。
|
deleteAuto |
否 |
String |
表示关闭自动创建快照策略时，是否需要清除所有自动创建的快照。 默认为“false”，表示不会删除之前已自动创建的快照。 设置为true，表示在关闭自动创建快照策略的同时，删除所有已创建的快照。 |
frequency |
否 |
String |
自动创建快照的执行频次。 说明：
默认值DAY，取值HOUR时，表示每小时整点执行一次；取值DAY时，表示每天执行一次；取值SUN、MON、TUE、WED、THU、FRI、SAT时，表示在每周对应时间执行一次。比如SUN表示每周日执行一次。保留快照个数与自动创建快照策略中设置的执行频次和索引有关。当执行频次间隔时间短或索引数据量大，保留自动快照可能会达不到设置的个数，请谨慎选择！ |
响应参数
无
请求示例
设置自动创建快照策略。
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy
{
"prefix" : "snapshot",
"period" : "16:00 GMT+08:00",
"keepday" : 7,
"frequency" : "DAY",
"enable" : "true",
"deleteAuto" : "false"
}
响应示例
无
状态码
状态码 |
描述 |
|---|---|
200 |
请求已成功。 |
406 |
服务器无法根据客户端请求的内容特性完成请求。 |
错误码
请参见错误码。
