文档首页> 云搜索服务 CSS> API参考> 快照管理接口> 查询自动创建快照的策略
更新时间：2024-04-22 GMT+08:00
查看PDF

查询自动创建快照的策略

功能介绍

该接口用于查询自动创建快照策略。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

指定需查询自动创建快照策略的集群ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

keepday

Integer

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

period

String

每天快照创建时刻。

prefix

String

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

bucket

String

快照存放的OBS桶的桶名。

basePath

String

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

agency

String

访问OBS桶用到的委托。

enable

String

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

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

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

frequency

String

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

请求示例

无

响应示例

状态码： 200

请求已成功。

{
  "keepday" : 2,
  "frequency" : "DAY",
  "period" : "16:00 GMT+08:00",
  "prefix" : "snapshot",
  "bucket" : "es-backup",
  "basePath" : "css_repository/tests",
  "agency" : "usearch",
  "enable" : "true"
}

状态码

状态码

描述

200

请求已成功。

406

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

错误码

请参见错误码。

父主题： 快照管理接口