すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:AddSnapshotRepo

最終更新日:Mar 17, 2025

クラスターの共有 OSS リポジトリを作成します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作には操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。 詳細については、共通リクエストパラメーターのドキュメントをご参照ください。

リクエスト構文

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

リクエストパラメーター

パラメーター

タイプ

位置

必須

説明

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

宛先インスタンスの ID。クロス クラスター OSS リポジトリのインスタンス ID を設定する必要があります。

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

クロス クラスターバックアップ情報、つまり指定された参照インスタンスを指定します。

リクエスト本文

クロス クラスターバックアップ情報、つまり参照インスタンスを指定するには、RequestBody パラメーターで次のパラメーターも指定する必要があります。

ヘッダー

タイプ

必須

説明

repoPath

String

Yes

es-cn-4591jumei000u****

データを復元するソースインスタンス。パラメーター情報を取得します。 詳細については、「代替スナップショットリポジトリの一覧表示」をご参照ください。 スナップショットが指定されると、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. インスタンスが見つからないため返されたエラーメッセージ。 インスタンスの状態を確認してください。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。