AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu
Docs Home
Docs Home
Docs Home

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs

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

名前
タイプ
説明

プロジェクトID

string

ジョブを所有するプロジェクトの一意の識別子。

ホスト ID

string

ジョブが表す ミラーリングされたコンフィギュレーションサーバー（ SCCC ）の一意の識別子。

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

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

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

false

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

名前
タイプ
必要性
説明

checkpointId

string

条件付き

データが復元される点を表す シャーディングされたクラスターチェックポイント の一意の識別子です。

条件:

  • "delivery.methodName" : "AUTOMATED_RESTORE"を設定します。

  • FCV4.0 またはそれ以前のバージョンを使用してシャーディングされたクラスターを実行します。

  • oplogInc 、 oplogTs 、またはpointInTimeUTCMillisは設定できません。

If you provide this setting, this endpoint restores all data up to this checkpoint to the database you specified in the delivery object.

delivery

オブジェクト

必須

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

delivery
.expires

string

条件付き

ISO 8601の日付と時刻形式（UTC）のタイムスタンプは、 URLが利用できなくなります。

delivery.methodName" : "HTTP"

delivery
.expirationHours

数値

条件付き

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

delivery.methodName" : "HTTP"

delivery
.maxDownloads

数値

条件付き

Number of times the download URL can be used. This must be 1 or greater.

delivery.methodName" : "HTTP"

delivery
.methodName

string

必須

Cloud Manager がデータを配信する方法を意味します。 指定できる値は以下のとおりです。

  • AUTOMATED_RESTORE

  • HTTP

"delivery.methodName" : "AUTOMATED_RESTORE"を設定する場合は、以下も設定する必要があります。

  • delivery.targetGroupId および

  • delivery.targetClusterId

さらに、応答にはdelivery.methodNameがHTTPとして表示されます。 自動復元では、 HTTPメソッドを使用して復元ジョブをターゲット ホストに送信します。

重要: SCP 経由の復元は、27、2018 年 3 月 日現在、削除されました。

delivery
.targetClusterId

string

条件付き

ターゲット クラスターの一意の識別子。 すべてのスナップショットを取得 および スナップショットエンドポイントを取得する のレスポンス本文に返されるclusterIdを使用します。

delivery.methodName" : "AUTOMATED_RESTORE".

ターゲット クラスターでバックアップが有効になって いない 場合、 「すべてのスナップショットの取得」エンドポイントはclusterId要素を持たない空のresults配列を返し、スナップショットの取得エンドポイントもclusterId要素を返しません。

delivery
.targetGroupId

string

条件付き

復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。

delivery.methodName" : "AUTOMATED_RESTORE"

oplogTs

string

条件付き

Oplog timestamp given as a Timestamp in the number of seconds that have elapsed since the UNIX epoch. When paired with oplogInc, they represent the point in time to which your data will be restored.

レプリカセットでlocal.oplog.rsに対してクエリを実行し、目的のタイムスタンプを見つけます。

"delivery.methodName" : "AUTOMATED_RESTORE" レプリカセットのみ。

oplogTsを設定すると、次の操作が発生します。

  • oplogIncを設定する必要があります。

  • checkpointIdまたはpointInTimeUTCMillisを設定できません。

この設定を指定すると、このエンドポイントは、delivery オブジェクトで指定したデータベースに、このoplogのタイムスタンプで指定された時刻までのすべてのデータを復元します。

oplogInc

string

条件付き

特定の秒内の操作を表す 32 ビットの増分序数。 oplogTsと組み合わせると、データが復元される時点を表します。

"delivery.methodName" : "AUTOMATED_RESTORE" レプリカセットのみ。

oplogIncを設定すると、次の操作が発生します。

  • oplogTsを設定する必要があります。

  • checkpointIdまたはpointInTimeUTCMillisを設定できません。

この設定を指定すると、このエンドポイントは、delivery オブジェクトで指定したデータベースに、このoplogのタイムスタンプで指定された時刻までのすべてのデータを復元します。

pointInTimeUTCMillis

long

条件付き

タイムスタンプ は、 UNIXエポック から経過したミリ秒数で表示され、データが復元される点を表します。このタイムスタンプは、現在の時刻から24 時間以内である必要があります。

If you provide this setting, this endpoint restores all data up to this Point in Time to the database you specified in the delivery object.

"delivery.methodName" : "AUTOMATED_RESTORE" レプリカセットのみ。

pointInTimeUTCMillisを設定した場合、 oplogInc 、 oplogTs 、またはcheckpointIdは設定できません。

snapshotId

string

条件付き

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

応答

名前
タイプ
説明

batchId

string

条件付き: シャーディングされたクラスターのみ。 この復元ジョブが属するバッチの一意の識別子。

clusterId

string

条件付き: クラスターのみ。 復元ジョブが表すクラスターの一意の識別子。

作成済み

string

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

delivery

オブジェクト

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

delivery.expirationHours

数値

条件付き: "delivery.methodName" : "HTTP"。復元ジョブが完了してからダウンロードURLが有効な時間数。

delivery.expires

string

条件付き: "delivery.methodName" : "HTTP"。 ISO 8601の日付と時刻形式（UTC）のタイムスタンプは、 URLが利用できなくなります。

delivery.maxDownloads

数値

条件付き: "delivery.methodName" : "HTTP". Number of times the download URL can be used. This must be 1 or greater.

delivery.methodName

string

データが配信される方法を意味します。 指定できる値は HTTP

IMPORTANT: Restore delivery via SCP has been removed as of March 27, 2018.

delivery.statusName

string

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

  • NOT_STARTED

  • IN_PROGRESS

  • READY

  • FAILED

  • INTERRUPTED

  • EXPIRED

  • MAX_DOWNLOADS_EXCEEDED

delivery. targetClusterId

string

条件付き: delivery.methodName" : "AUTOMATED_RESTORE"。復元ジョブを実行するための宛先クラスターの一意の識別子。

delivery. targetGroupId

string

条件付き: delivery.methodName" : "AUTOMATED_RESTORE"。復元ジョブの宛先クラスターを含むプロジェクトの一意の識別子。

delivery.url

string

条件付き: "delivery.methodName" : "HTTP"。復元された スナップショット データをダウンロードできる URL 。

グループ ID

string

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

ハッシュ

オブジェクト配列

対応するdelivery.urlがダウンロードされている場合、この配列内の各ドキュメントは、復元ファイルを ハッシュされたチェックサム値にマッピング します。 この配列は、ファイルがダウンロードされた後にのみ存在します。

HTTP復元の場合、この配列には.tar.gzファイルのハッシュを表す 1 つのオブジェクトのみが含まれます。

hashs.fileName

string

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

ハッシュ。

string

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

hashs.typeName

string

ハッシュ値を計算するために使用されるハッシュ アルゴリズム。 存在する場合、この値はSHA1です。

hostId

string

条件付き:ミラーリングされたコンフィギュレーションサーバー（ SCCC ）。 この復元ジョブが属するコンフィギュレーションサーバーの一意の識別子。

id

string

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

Links

オブジェクト配列

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

snapshotId

string

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

statusName

string

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

  • FINISHED

  • IN_PROGRESS

  • BROKEN

  • KILLED

タイムスタンプ

オブジェクト

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

timestamp.date

string

Timestamp in ISO 8601 date and time format in UTC of the latest oplog entry in the restored snapshot.

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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs?pretty=true" \
     --data '
      {
        "delivery" : {
          "expirationHours" : 1,
          "expires" : "2017-04-21T04:49:57Z",
          "maxDownloads" : 1,
          "methodName" : "HTTP",
          "statusName" : "READY",
          "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
        },
        "snapshotId" : "{SNAPSHOT-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}

レスポンス本体

{
  "created" : "2017-08-25T16:22:15Z",
  "delivery" : {
    "expirationHours" : 1,
    "expires" : "2017-04-21T04:49:57Z",
    "maxDownloads" : 1,
    "methodName" : "HTTP",
    "statusName" : "READY",
    "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz"
  },
  "encryptionEnabled" : true,
  "groupId" : "{PROJECT-ID}",
  "hostId" : "{HOST-ID}",
  "id" : "{JOB-ID}",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs/{JOB-ID}",
    "rel" : "self"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}",
    "rel" : "http://mms.mongodb.com/cluster"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}",
    "rel" : "http://mms.mongodb.com/snapshot"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
    "rel" : "http://mms.mongodb.com/group"
  } ],
  "masterKeyUUID" : "{UUID}",
  "snapshotId" : "{SNAPSHOT-ID}",
  "statusName" : "IN_PROGRESS"
}
このページを評価

項目一覧