全部產品
Search
文件中心

Elasticsearch:AddSnapshotRepo

更新時間:Jan 15, 2025

在設定跨叢集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. 執行個體找不到,請核對執行個體狀態。

訪問錯誤中心查看更多錯誤碼。