文档

AddSnapshotRepo

在设置跨集群OSS仓库时,创建引用仓库。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/instances/{InstanceId}/snapshot-repos HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

InstanceId String Path es-cn-n6w1o1x0w001c****

目标端实例ID,需要设置跨集群OSS仓库的实例ID。

String Body { "repoPath" :"es-cn-4591jumei000u****" }

指定跨集群备份信息,即指定引用实例。

RequestBody

RequestBody中还需填入以下参数,用来指定跨集群备份信息,即指定引用实例。

名称

类型

是否必选

示例值

描述

repoPath

String

es-cn-4591jumei000u****

需要恢复数据的源端实例。获取参数信息,请参见ListAlternativeSnapshotRepos。指定后,Elasticsearch会为您创建该源端实例的快照引用仓库,您可以从该快照仓库进行数据恢复。

该实例与目标端实例需要满足以下条件:

相同区域;归属于相同账号;源端实例的版本低于或等于目标端实例的版本,更多限制详情请参见设置跨集群OSS仓库

示例如下。

{
    "repoPath" :"es-cn-4591jumei000u****"
}

返回数据

名称

类型

示例值

描述

Result Boolean true

返回结果:

  • true:引用仓库创建成功
  • false:引用仓库创建失败
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

请求ID。

示例

请求示例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/snapshot-repos HTTP/1.1
{
    "repoPath" :"es-cn-4591jumei000u****"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "D21379E3-A54E-4C86-A64C-3717365F****"
}

错误码

HttpCode

错误码

错误信息

描述

400 InstanceActivating Instance is activating. 实例目前处于生效中。
400 InstanceNotFound The instanceId provided does not exist. 实例找不到,请核对实例状态。

访问错误中心查看更多错误码。