AddSnapshotRepo - 创建引用仓库

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:AddSnapshotRepo

create

*全部资源

*

无 无

请求语法

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

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

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

es-cn-n6w1o1x0w001c****

请求参数

名称

类型

必填

描述

示例值

body

string

否

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

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

RequestBody

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

名称类型是否必选示例值描述
repoPathString是es-cn-4591jumei000u****需要恢复数据的源端实例。获取参数信息,请参见 ListAlternativeSnapshotRepos 。指定后,Elasticsearch 会为您创建该源端实例的快照引用仓库,您可以从该快照仓库进行数据恢复。
该实例与目标端实例需要满足以下条件:
相同区域;归属于相同账号;源端实例的版本低于或等于目标端实例的版本,更多限制详情请参见设置跨集群 OSS 仓库。




示例如下。

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

返回参数

名称

类型

描述

示例值

object

Result

boolean

返回结果:

  • true:引用仓库创建成功

  • false:引用仓库创建失败

true

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

示例

正常返回示例

JSON格式

{
  "Result": true,
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InstanceActivating Instance is activating. 实例目前处于生效中。
400 InstanceNotFound The instanceId provided does not exist.

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

变更历史

更多信息,参考变更详情。