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

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

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

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs/{JOB-ID}

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

名前
タイプ
説明

プロジェクトID

string

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

ホスト ID

string

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

JOB-ID

string

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

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

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

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

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

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

名前
タイプ
説明

batchId

string

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

clusterId

string

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

作成済み

string

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

delivery

オブジェクト

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

delivery.expirationHours

数値

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

delivery.expires

string

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

delivery.maxDownloads

数値

条件付き: "delivery.methodName" : "HTTP"。ダウンロードするURLを使用できる回数。これは 1 以上である必要があります。

delivery.methodName

string

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

  • HTTP

重要: SCP を介した復元する配達は、2018 年 27 月をもって削除されました。

delivery.statusName

string

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

  • NOT_STARTED

  • IN_PROGRESS

  • READY

  • FAILED

  • INTERRUPTED

  • EXPIRED

  • MAX_DOWNLOADS_EXCEEDED

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 リンク仕様で説明されています。

pointInTime

ブール値

PIT 復元のジョブがPIT復元のジョブであることを示すフラグ。

snapshotId

string

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

statusName

string

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

  • FINISHED

  • IN_PROGRESS

  • BROKEN

  • KILLED

タイムスタンプ

オブジェクト

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

timestamp.date

string

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

timestamp.increment

string

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

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs/{JOB-ID}?pretty=true"

応答例

応答ヘッダー

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{  "batchId" : "{BATCH-ID}",  "created" : "2016-03-04T22:07:27Z",  "delivery" : {    "expirationHours" : 1,    "expires" : "2016-03-04T23:07:27Z",    "maxDownloads" : 1,    "methodName" : "HTTP",    "statusName" : "READY",    "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/1976673072885966399/electron_0-1456098690-{JOB-ID}.tar.gz"  },  "encryptionEnabled" : false,  "groupId" : "{PROJECT-ID}",  "hostId" : "{HOST-ID}",  "id" : "{JOB-ID}",  "links" : [ {
  } ],  "pointInTime" : false,  "snapshotId" : "{SNAPSHOT-ID}",  "statusName" : "FINISHED",  "timestamp" : {    "date" : "2017-04-19T21:14:25Z",    "increment" : 1  }}
このページを評価

項目一覧