文档首页> 云搜索服务 CSS> API参考 (巴黎、阿姆斯特丹区域) > 快照管理接口> 设置自动创建快照策略
更新时间：2023-06-20 GMT+08:00
查看PDF

设置自动创建快照策略

功能介绍

该接口用于设置自动创建快照，默认一天创建一个快照。

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

cluster_id

是

String

指定要自动创建快照的集群ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

prefix

否

String

自动创建快照的名称前缀，需要用户自己手动输入。只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。

说明：

当enable取值为true时，prefix参数必填。

period

否

String

每天创建快照的时刻，只支持整点，后面需加上时区，格式为“HH:mm z”，“HH:mm”表示整点时间，“z”表示时区。比如“00:00 GMT+08:00”、“01:00 GMT+08:00”等。

说明：

当enable取值为true时，period参数必填。

keepday

否

Integer

自定义设置快照保留的天数，范围是1～90。系统在半点时刻会自动删除超过保留天数的快照。

说明：

当enable取值为true时，keepday参数必填。

enable

是

String

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

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

deleteAuto

否

String

表示关闭自动创建快照策略时，是否需要清除所有自动创建的快照。默认为“false”，表示不会删除之前已自动创建的快照。设置为true，表示在关闭自动创建快照策略的同时，删除所有已创建的快照。

响应参数

无

请求示例

{
  "prefix" : "snapshot",
  "period" : "16:00 GMT+08:00",
  "keepday" : 7,
  "enable" : "true",
  "deleteAuto" : "false"
}

响应示例

无

状态码

状态码

描述

200

请求已成功。

406

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

错误码

请参见错误码。

父主题： 快照管理接口