文档首页> 云搜索服务 CSS> API参考> 快照管理接口> 修改集群快照的基础配置
更新时间:2024-04-22 GMT+08:00

修改集群快照的基础配置

功能介绍

该接口用于修改集群快照的基础配置,可修改OBS桶和IAM委托。

可以使用该接口开启快照功能。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

cluster_id

String

指定待操作的集群ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bucket

String

备份使用的OBS桶的桶名。

agency

String

委托名称,委托给CSS,允许CSS调用您的其他云服务。

basePath

String

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

响应参数

请求示例

开启快照功能。

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/setting

{
  "bucket" : "test-bucket",
  "agency" : "usearch",
  "basePath" : "css_repository/Es-name"
}

响应示例

状态码

状态码

描述

200

请求已成功。

406

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

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

504

网关超时。

错误码

请参见错误码