1 つのクラスターの 1 つの復元ジョブを作成

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

このエンドポイントへのすべてのリクエストは、MongoDB Ops Manager ユーザーの API アクセスリストの IP アドレスから送信される必要があります。 API アクセスリストの構成に関する詳細なドキュメントについては、「組織に対して API アクセスリストが必要」を参照してください。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs

リクエストパスパラメーター

名前	タイプ	説明
`PROJECT-ID`	string	ジョブを所有するプロジェクトの一意の識別子。
`CLUSTER-ID`	string	ジョブが表すクラスターの一意の識別子。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
状態	HTTPレスポンスコード
envelope	期待される応答本体

false

リクエストボディパラメータ

名前	タイプ	必要性	説明
`delivery`	オブジェクト	必須	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.expires`	string	条件付き	ISO8601 のタイムスタンプ UTC の日付と時刻形式に設定し、その後 URL が利用できなくなります。 `delivery.expires`を設定した場合、 `delivery.expirationHours`は設定できません。
`delivery` `.expirationHours`	数値	条件付き	復元ジョブが完了してからダウンロードURLが有効な時間数。 `delivery.expirationHours`を設定した場合、 `delivery.expires`は設定できません。
`delivery` `.maxDownloads`	数値	必須	ダウンロードURLを使用できる回数。これは`1`以上である必要があります。
`delivery` `.methodName`	string	必須	MongoDB Ops Managerがデータを配信する方法を意味します。を`HTTP`に設定します。
`snapshotId`	string	必須	復元するスナップショットの一意の識別子。

注意

条件

"delivery.methodName" : AUTOMATED_RESTORE"を設定する場合は、 delivery.targetGroupIdとdelivery.targetClusterIdを設定する必要があります。

スナップショットからの自動復元を作成します。

名前	タイプ	必要性	説明
`delivery`	オブジェクト	必須	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	必須	MongoDB Ops Managerがデータを配信する方法を意味します。を`AUTOMATED_RESTORE`に設定します。レスポンスには`"delivery.methodName" : "HTTP"`が表示されます。自動復元では、 `HTTP`メソッドを使用して復元ジョブをターゲットホストに送信します。重要 SCP経由の復元配信はMongoDB Ops Manager 4.0 で削除されました。
`delivery` `.targetClusterId`	string	必須	ターゲットクラスターの一意の識別子。すべてのスナップショットを取得およびスナップショットエンドポイントを取得するのレスポンス本文に返される`clusterId`を使用します。ターゲットクラスターでバックアップが有効になっていない場合、「すべてのスナップショットの取得」エンドポイントは`clusterId`要素を持たない空の`results`配列を返し、スナップショットの取得エンドポイントも`clusterId`要素を返しません。
`delivery` `.targetGroupId`	string	必須	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`snapshotId`	string	必須	復元するスナップショットの一意の識別子。

oplogタイムスタンプからの自動復元の作成

oplog復元は、MongoDB 4.2以降の FCV を使用するバージョンまたはシャーディングされたクラスターを使用するレプリカセットで機能します。

名前	タイプ	必要性	説明
`delivery`	オブジェクト	必須	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	必須	MongoDB Ops Managerがデータを配信する方法を意味します。を`AUTOMATED_RESTORE`に設定します。レスポンスには`"delivery.methodName" : "HTTP"`が表示されます。自動復元では、 `HTTP`メソッドを使用して復元ジョブをターゲットホストに送信します。重要 SCP経由の復元配信はMongoDB Ops Manager 4.0 で削除されました。
`delivery` `.targetClusterId`	string	必須	ターゲットクラスターの一意の識別子。すべてのスナップショットを取得およびスナップショットエンドポイントを取得するのレスポンス本文に返される`clusterId`を使用します。ターゲットクラスターでバックアップが有効になっていない場合、「すべてのスナップショットの取得」エンドポイントは`clusterId`要素を持たない空の`results`配列を返し、スナップショットの取得エンドポイントも`clusterId`要素を返しません。
`delivery` `.targetGroupId`	string	必須	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`oplogTs`	string	必須	oplogタイムスタンプとして指定された UNIXエポックからの経過秒数。`oplogInc`と組み合わせると、データが復元される時点を表します。レプリカセットで`local.oplog.rs`に対してクエリを実行し、目的のタイムスタンプを見つけます。この設定を指定すると、このエンドポイントは、`delivery` オブジェクトで指定したデータベースに、このoplogのタイムスタンプで指定された時刻までのすべてのデータを復元します。
`oplogInc`	string	必須	特定の秒内の操作を表す 32 ビットの増分序数。 `oplogTs`と組み合わせると、データが復元される時点を表します。この設定を指定すると、このエンドポイントは、`delivery` オブジェクトで指定したデータベースに、このoplogのタイムスタンプで指定された時刻までのすべてのデータを復元します。

特定の時点からの自動復元を作成します。

PIT 復元は、任意の MongoDB バージョンを使用するレプリカセット、または4.2以降のFCVを使用するシャーディングされたクラスターで機能します。

名前	タイプ	必要性	説明
`delivery`	オブジェクト	必須	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	必須	MongoDB Ops Managerがデータを配信する方法を意味します。を`AUTOMATED_RESTORE`に設定します。レスポンスには`"delivery.methodName" : "HTTP"`が表示されます。自動復元では、 `HTTP`メソッドを使用して復元ジョブをターゲットホストに送信します。重要 SCP経由の復元配信はMongoDB Ops Manager 4.0 で削除されました。
`delivery` `.targetClusterId`	string	必須	ターゲットクラスターの一意の識別子。すべてのスナップショットを取得およびスナップショットエンドポイントを取得するのレスポンス本文に返される`clusterId`を使用します。ターゲットクラスターでバックアップが有効になっていない場合、「すべてのスナップショットの取得」エンドポイントは`clusterId`要素を持たない空の`results`配列を返し、スナップショットの取得エンドポイントも`clusterId`要素を返しません。
`delivery` `.targetGroupId`	string	必須	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`pointInTimeUTCMillis`	long	必須	UNIXエポックからの経過ミリ秒単位のタイムスタンプこれは、データが復元される時点を表します。このタイムスタンプは、現在の時刻から24時間以内である必要があります。この設定を指定すると、このエンドポイントは、このポイントインタイムまでのすべてのデータを、 `delivery`オブジェクトで指定したデータベースに復元します。

チェックポイントからの自動復元を作成します。チェックポイントの復元は、 FCV が4.0 またはそれ以前の MongoDB クラスターを実行しているシャーディングされたクラスターで機能します。

重要

FCVが4.2以降の MongoDB クラスターのチェックポイント復元は使用しないでください。

名前	タイプ	必要性	説明
`checkpointId`	string	必須	データが復元される点を表すシャーディングされたクラスターチェックポイントの一意の識別子です。この設定を指定すると、このエンドポイントは、このチェックポイントまでのすべてのデータを、 `delivery`オブジェクトで指定したデータベースに復元します。
`delivery`	オブジェクト	必須	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	必須	MongoDB Ops Managerがデータを配信する方法を意味します。を`AUTOMATED_RESTORE`に設定します。レスポンスには`"delivery.methodName" : "HTTP"`が表示されます。自動復元では、 `HTTP`メソッドを使用して復元ジョブをターゲットホストに送信します。
`delivery` `.targetClusterId`	string	必須	ターゲットクラスターの一意の識別子。すべてのスナップショットを取得およびスナップショットエンドポイントを取得するのレスポンス本文に返される`clusterId`を使用します。ターゲットクラスターでバックアップが有効になっていない場合、「すべてのスナップショットの取得」エンドポイントは`clusterId`要素を持たない空の`results`配列を返し、スナップショットの取得エンドポイントも`clusterId`要素を返しません。
`delivery` `.targetGroupId`	string	必須	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

各結果は 1 つのクラスター復元ジョブです。この配列には 1 つの復元ジョブのみが含まれます。

名前

タイプ

説明

batchId

string

この復元ジョブが属するバッチの一意の識別子。スナップショットがシャーディングされたクラスターからのものであった場合に返されます。

clusterId

string

復元ジョブが表すクラスターの一意の識別子。スナップショットがレプリカセットまたはシャーディングされたクラスターからのものであった場合に返されます。

created

string

ISO8601 のタイムスタンプ復元ジョブが要求されたときの日付と時刻形式（ UTC）。

delivery

オブジェクト

復元されたスナップショットデータの配信方法と詳細。

delivery

.authBearer

string

urlV2へのリクエストの認可ベアラ。値はBearerである必要があります。

delivery

.authHeader

string

urlV2へのリクエストの認可ヘッダー。値はAuthorizationである必要があります。

delivery

.authValue

string

urlV2へのリクエストのベアラの値。ベアラーのauthValueは、トークン値である必要があります。

delivery

.expirationHours

数値

復元ジョブが完了してからダウンロードURLが有効な時間数。

delivery

.expires

string

ISO8601 のタイムスタンプ UTC の日付と時刻形式に設定し、その後 URL が利用できなくなります。

delivery

.maxDownloads

数値

ダウンロードURLを使用できる回数。これは1以上である必要があります。

delivery

.methodName

string

データが配信される方法を意味します。 HTTPを返します。

delivery

.statusName

string

ダウンロード可能なファイルの現在のステータス。 Accepted values are:

NOT_STARTED
IN_PROGRESS
READY
FAILED
INTERRUPTED
EXPIRED
MAX_DOWNLOADS_EXCEEDED

delivery

.url

string

復元されたスナップショットデータをダウンロードできる URL 。

delivery

.urlV2

string

復元されたスナップショットデータを安全にダウンロードできる URL 。このURLへのリクエストには、HTTP リクエストヘッダーにauthHeader 、 authBearer 、 authValueが含まれている必要があります。 urlv2から安全にダウンロードするためのリクエストヘッダーは次の形式である必要があります。

"<authHeader>:<authBearer> <authValue>" <urlV2>

例

curl -H "Authorization: Bearer {AUTH-TOKEN}" \
     https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}"

groupId

string

復元ジョブを所有するグループの一意の識別子。

hashes

オブジェクトの配列

対応するdelivery.urlがダウンロードされている場合、この配列は.tar.gzファイルのハッシュを表す 1 つのオブジェクトを返します。

hashes

.fileName

string

ハッシュされたスナップショットファイルの名前。

hashes

.hash

string

スナップショットファイルのハッシュ。

hashes

.typeName

string

ハッシュ値を計算するために使用されるハッシュアルゴリズム。返された場合、値はSHA1に設定されます。

hostId

string

この復元ジョブが属するコンフィギュレーションサーバーの一意の識別子。コンフィギュレーションサーバーがSCCCであった場合に返されます。

id

string

復元ジョブの一意の識別子。

links

オブジェクトの配列

サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべてのlinks配列には、 selfと呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。

pointInTime

ブール値

スナップショットが特定の時点のものかどうかを示すフラグ。

snapshotId

string

復元するスナップショットの一意の識別子。

statusName

string

ジョブの現在のステータス。指定できる値は以下のとおりです。

FINISHED
IN_PROGRESS
BROKEN
KILLED

timestamp

オブジェクト

スナップショットが作成されたときのoplogエントリのタイムスタンプ。

timestamp

.date

string

ISO8601 のタイムスタンプ復元されたスナップショット内の最新の oplog エントリーの UTC 形式の日付と時刻形式。

timestamp

.increment

string

復元されたスナップショット内の最新の oplog エントリで完了したすべての操作の順序。

名前	タイプ	説明
`batchId`	string	この復元ジョブが属するバッチの一意の識別子。スナップショットがシャーディングされたクラスターからのものであった場合に返されます。
`clusterId`	string	復元ジョブが表すクラスターの一意の識別子。スナップショットがレプリカセットまたはシャーディングされたクラスターからのものであった場合に返されます。
`created`	string	ISO8601 のタイムスタンプ復元ジョブが要求されたときの日付と時刻形式（ UTC）。
`delivery`	オブジェクト	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	データが配信される方法を意味します。 `HTTP`を返します。
`delivery` `.targetClusterId`	string	復元ジョブを実行するための宛先クラスターの一意の識別子。
`delivery` `.targetGroupId`	string	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`groupId`	string	復元ジョブを所有するグループの一意の識別子。
`hostId`	string	この復元ジョブが属するコンフィギュレーションサーバーの一意の識別子。コンフィギュレーションサーバーがSCCCであった場合に返されます。
`id`	string	復元ジョブの一意の識別子。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`pointInTime`	ブール値	スナップショットが特定の時点のものかどうかを示すフラグ。
`snapshotId`	string	復元するスナップショットの一意の識別子。
`statusName`	string	ジョブの現在のステータス。指定できる値は以下のとおりです。 `FINISHED` `IN_PROGRESS` `BROKEN` `KILLED`
`timestamp`	オブジェクト	スナップショットが作成されたときのoplogエントリのタイムスタンプ。
`timestamp` `.date`	string	ISO8601 のタイムスタンプ復元されたスナップショット内の最新の oplog エントリーの UTC 形式の日付と時刻形式。
`timestamp` `.increment`	string	復元されたスナップショット内の最新の oplog エントリで完了したすべての操作の順序。

名前	タイプ	説明
`batchId`	string	この復元ジョブが属するバッチの一意の識別子。スナップショットがシャーディングされたクラスターからのものであった場合に返されます。
`clusterId`	string	復元ジョブが表すクラスターの一意の識別子。スナップショットがレプリカセットまたはシャーディングされたクラスターからのものであった場合に返されます。
`created`	string	ISO8601 のタイムスタンプ復元ジョブが要求されたときの日付と時刻形式（ UTC）。
`delivery`	オブジェクト	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	データが配信される方法を意味します。 `HTTP`を返します。
`delivery` `.targetClusterId`	string	復元ジョブを実行するための宛先クラスターの一意の識別子。
`delivery` `.targetGroupId`	string	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`groupId`	string	復元ジョブを所有するグループの一意の識別子。
`hostId`	string	この復元ジョブが属するコンフィギュレーションサーバーの一意の識別子。コンフィギュレーションサーバーがSCCCであった場合に返されます。
`id`	string	復元ジョブの一意の識別子。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`pointInTime`	ブール値	スナップショットが特定の時点のものかどうかを示すフラグ。
`snapshotId`	string	復元するスナップショットの一意の識別子。
`statusName`	string	ジョブの現在のステータス。指定できる値は以下のとおりです。 `FINISHED` `IN_PROGRESS` `BROKEN` `KILLED`
`timestamp`	オブジェクト	スナップショットが作成されたときのoplogエントリのタイムスタンプ。
`timestamp` `.date`	string	ISO8601 のタイムスタンプ復元されたスナップショット内の最新の oplog エントリーの UTC 形式の日付と時刻形式。
`timestamp` `.increment`	string	復元されたスナップショット内の最新の oplog エントリで完了したすべての操作の順序。

名前	タイプ	説明
`batchId`	string	この復元ジョブが属するバッチの一意の識別子。スナップショットがシャーディングされたクラスターからのものであった場合に返されます。
`clusterId`	string	復元ジョブが表すクラスターの一意の識別子。スナップショットがレプリカセットまたはシャーディングされたクラスターからのものであった場合に返されます。
`created`	string	ISO8601 のタイムスタンプ復元ジョブが要求されたときの日付と時刻形式（ UTC）。
`delivery`	オブジェクト	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	データが配信される方法を意味します。 `HTTP`を返します。
`delivery` `.targetClusterId`	string	復元ジョブを実行するための宛先クラスターの一意の識別子。
`delivery` `.targetGroupId`	string	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`groupId`	string	復元ジョブを所有するグループの一意の識別子。
`hostId`	string	この復元ジョブが属するコンフィギュレーションサーバーの一意の識別子。コンフィギュレーションサーバーがSCCCであった場合に返されます。
`id`	string	復元ジョブの一意の識別子。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`pointInTime`	ブール値	スナップショットが特定の時点のものかどうかを示すフラグ。
`snapshotId`	string	復元するスナップショットの一意の識別子。
`statusName`	string	ジョブの現在のステータス。指定できる値は以下のとおりです。 `FINISHED` `IN_PROGRESS` `BROKEN` `KILLED`
`timestamp`	オブジェクト	スナップショットが作成されたときのoplogエントリのタイムスタンプ。
`timestamp` `.date`	string	ISO8601 のタイムスタンプ復元されたスナップショット内の最新の oplog エントリーの UTC 形式の日付と時刻形式。
`timestamp` `.increment`	string	復元されたスナップショット内の最新の oplog エントリで完了したすべての操作の順序。

名前	タイプ	説明
`batchId`	string	この復元ジョブが属するバッチの一意の識別子。スナップショットがシャーディングされたクラスターからのものであった場合に返されます。
`checkpointId`	string	データが復元される点を表すシャーディングされたクラスターチェックポイントの一意の識別子です。
`clusterId`	string	復元ジョブが表すクラスターの一意の識別子。スナップショットがレプリカセットまたはシャーディングされたクラスターからのものであった場合に返されます。
`created`	string	ISO8601 のタイムスタンプ復元ジョブが要求されたときの日付と時刻形式（ UTC）。
`delivery`	オブジェクト	復元されたスナップショットデータの配信方法と詳細。
`delivery` `.methodName`	string	データが配信される方法を意味します。 `HTTP`を返します。
`delivery` `.targetClusterId`	string	復元ジョブを実行するための宛先クラスターの一意の識別子。
`delivery` `.targetGroupId`	string	復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。
`groupId`	string	復元ジョブを所有するグループの一意の識別子。
`hostId`	string	この復元ジョブが属するコンフィギュレーションサーバーの一意の識別子。コンフィギュレーションサーバーがSCCCであった場合に返されます。
`id`	string	復元ジョブの一意の識別子。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`pointInTime`	ブール値	スナップショットが特定の時点のものかどうかを示すフラグ。
`statusName`	string	ジョブの現在のステータス。指定できる値は以下のとおりです。 `FINISHED` `IN_PROGRESS` `BROKEN` `KILLED`
`timestamp`	オブジェクト	スナップショットが作成されたときのoplogエントリのタイムスタンプ。
`timestamp` `.date`	string	ISO8601 のタイムスタンプ復元されたスナップショット内の最新の oplog エントリーの UTC 形式の日付と時刻形式。
`timestamp` `.increment`	string	復元されたスナップショット内の最新の oplog エントリで完了したすべての操作の順序。

リクエストの例

HTTPを使用して圧縮されたスナップショットを転送する復元ジョブを作成します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "expirationHours" : "1",
       "maxDownloads" : "1",
       "methodName" : "HTTP"
     },
     "snapshotId" : "{SNAPSHOT-ID}"
   }'

スナップショットからの自動復元を作成します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
     --data '
       {
         "delivery" : {
           "methodName" : "AUTOMATED_RESTORE",
           "targetGroupId" : "{TARGET-PROJECT-ID}",
           "targetClusterId" : "{TARGET-CLUSTER-ID}"
         },
         "snapshotId": "{SNAPSHOT-ID}"
       }'

oplogタイムスタンプからの自動復元の作成

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "methodName" : "AUTOMATED_RESTORE",
       "targetGroupId" : "{TARGET-PROJECT-ID}",
       "targetClusterId" : "{TARGET-CLUSTER-ID}"
     },
     "oplogTs" : "1536610288",
     "oplogInc" : "1"
   }'

特定の時点からの自動復元を作成します。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "methodName" : "AUTOMATED_RESTORE",
       "targetGroupId" : "{TARGET-PROJECT-ID}",
       "targetClusterId" : "{TARGET-CLUSTER-ID}"
     },
     "pointInTimeUTCMillis" : "1536610288000"
   }'

チェックポイントからの自動復元を作成します。 FCV が4.0 またはそれ以前の MongoDB クラスターを実行しているシャーディングされたクラスターにのみ有効です。

重要

FCVが4.2以降の MongoDB クラスターのチェックポイント復元は使用しないでください。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "methodName" : "AUTOMATED_RESTORE",
       "targetGroupId" : "{TARGET-PROJECT-ID}",
       "targetClusterId" : "{TARGET-CLUSTER-ID}"
     },
     "checkpointId" : "{CHECKPOINT-ID}"
   }'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId": "{BATCH-ID}",
    "clusterId": "{CLUSTER-ID}",
    "created": "2018-09-20T15:00:00Z",
    "delivery": {
      "authBearer": "Bearer",
      "authHeader": "Authorization",
      "expirationHours": 1,
      "maxDownloads": 1,
      "methodName": "HTTP",
      "statusName": "READY"
    },
    "encryptionEnabled": false,
    "groupId": "{PROJECT-ID}",
    "id": "{RESTORE-JOB-ID}",
    "links": [{
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}",
      "rel": "self"
    }],
    "pointInTime": false,
    "snapshotId": "{SNAPSHOT-ID}",
    "statusName": "FINISHED",
    "timestamp": {
      "date": "2018-09-15T15:53:00Z",
      "increment": 1
    }
  } ],
  "totalCount" : 1,
  "url": "{DOWNLOAD-URL}",
  "urlV2": "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}"
}

{
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-ID}",
    "created" : "2020-04-21T03:49:57Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2020-04-21T04:49:57Z",
      "maxDownloads" : 1,
      "methodName" : "HTTP",
      "statusName" : "READY",
      "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
    },
    "encryptionEnabled" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2020-04-18T15:14:25Z",
      "increment" : 1
    }
  } ],
  "totalCount" : 1
}

{
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId": "{BATCH-ID}",
    "clusterId": "{CLUSTER-ID}",
    "created": "2018-09-20T15:01:00Z",
    "delivery": {
      "methodName": "HTTP",
      "statusName": "READY"
    },
    "encryptionEnabled": false,
    "groupId": "{PROJECT-ID}",
    "id": "{RESTORE-JOB-ID}",
    "links": [{
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}",
      "rel": "self"
    }],
    "pointInTime": false,
    "snapshotId": "{SNAPSHOT-ID}",
    "statusName": "FINISHED",
    "timestamp": {
      "date": "2018-09-15T15:53:00Z",
      "increment": 1
    }
  } ],
  "totalCount" : 1
}

{
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId": "{BATCH-ID}",
    "clusterId": "{CLUSTER-ID}",
    "created": "2018-09-20T15:02:00Z",
    "delivery": {
      "methodName": "HTTP",
      "statusName": "READY"
    },
    "encryptionEnabled": false,
    "groupId": "{PROJECT-ID}",
    "id": "{RESTORE-JOB-ID}",
    "links": [{
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}",
      "rel": "self"
    }],
    "snapshotId": "{SNAPSHOT-ID}",
    "statusName": "FINISHED",
    "timestamp": {
      "date": "2018-09-15T15:53:00Z",
      "increment": 1
    }
  } ],
  "totalCount" : 1
}

{
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "batchId": "{BATCH-ID}",
    "clusterId": "{CLUSTER-ID}",
    "created": "2018-09-20T15:03:00Z",
    "delivery": {
      "methodName": "HTTP",
      "statusName": "READY"
    },
    "encryptionEnabled": false,
    "groupId": "{PROJECT-ID}",
    "id": "{RESTORE-JOB-ID}",
    "links": [{
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}",
      "rel": "self"
    }],
    "snapshotId": "{SNAPSHOT-ID}",
    "statusName": "FINISHED",
    "timestamp": {
      "date": "2018-09-15T15:53:00Z",
      "increment": 1
    }
  } ],
  "totalCount" : 1
}

戻る

1 つのクラスターの 1 つの復元ジョブを取得

1 つのレガシーミラーリングされたコンフィギュレーションサーバーのすべての復元ジョブを取得

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

注意

条件

重要

重要

重要

重要

応答

応答ドキュメント

results embeddedDocument

例

リクエストの例

重要

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ

`results` embeddedDocument