开启自动创建快照功能
功能介绍
该接口用于打开自动备份功能。
调用方法
请参见如何调用API。
URI
POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/open
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID和名称。 |
|
cluster_id |
是 |
String |
快照所属的集群的ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
indices |
否 |
String |
指定要备份的索引名称，多个索引用逗号隔开，默认恢复所有索引。支持使用“*”匹配多个索引，例如：2018-06*，表示恢复名称前缀是2018-06的所有索引的数据。0～1024个字符，不能包含空格和大写字母，且不能包含"\<|>/?特殊字符。默认值为*，表示备份所有索引。 |
|
keepday |
是 |
Integer |
自定义设置快照保留的个数，范围是1～90。系统在半点时刻会自动删除超过保留个数的快照。过期删除策略只针对与当前自动创建快照策略相同执行频次的自动快照。 |
|
frequency |
否 |
String |
自动创建快照的执行频次。
说明：
默认值DAY，取值HOUR时，表示每小时整点执行一次；取值DAY时，表示每天执行一次；取值SUN、MON、TUE、WED、THU、FRI、SAT时，表示在每周对应时间执行一次。比如SUN表示每周日执行一次。保留快照个数与自动创建快照策略中设置的执行频次和索引有关。当执行频次间隔时间短或索引数据量大，保留自动快照可能会达不到设置的个数，请谨慎选择！ |
|
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值，默认从设置成功的下一整点创建。 |
|
prefix |
是 |
String |
自动创建的快照名称前缀，需要用户自己手动输入。只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。 |
响应参数
无
请求示例
打开自动备份功能。
POST /v2.0/6204a5bd270343b5885144cf9c8c158d/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 |
请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
