/ /

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

クラスターのすべての復元ジョブを取得します。 CLUSTER-IDは、レプリカセットまたはシャーディングされたクラスターのいずれかの ID である必要があります。

注意

BATCH-IDクエリパラメータを使用すると、指定されたバッチ内のすべての復元ジョブを検索できます。シャーディングされたクラスターの復元ジョブを作成する場合、Cloud Manager はシャードごとに個別のジョブを作成し、さらにコンフィギュレーションサーバー用に別のジョブを作成します。これらの各ジョブはバッチの一部です。ただし、レプリカセットの復元ジョブをバッチの一部にすることはできません。

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

リソース

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

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?batchId={BATCH-ID}

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

名前	タイプ	説明
プロジェクトID	string	Unique identifier of the project that owns the snapshot.
CLUSTER-ID	string	スナップショットが表すクラスターの一意の識別子。

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

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
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. 結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 Cloud Manager は、レスポンス本体に`status`フィールドを追加します。	`false`
backupJobsEnabledOnly	ブール値	任意	データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。これを`false`に設定し、 `backupJobsEnabled`フラグが`false`に設定されているデーモン構成を含めます。	`true`

バッチ ID

string

バッチの一意の識別子。

NONE

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

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

応答

応答ドキュメント

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

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

`results` embeddedDocument

各結果は 1 つのクラスター復元ジョブです。

名前	タイプ	説明
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` 重要: SCP 経由の復元は、27、2018 年 3 月日現在、削除されました。
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	Timestamp in ISO 8601 date and time format in UTC of the latest oplog entry in the restored snapshot.
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}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true"

応答例

応答ヘッダー

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://cloud.mongodb.com/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" : "2017-04-21T03:49:57Z",
    "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" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-18T15:14:25Z",
      "increment" : 1
    }
  }, {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-ID}",
    "created" : "2017-04-18T19:21:23Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2017-04-18T20:21:23Z",
      "maxDownloads" : 1,
      "methodName" : "HTTP",
      "statusName" : "READY",
      "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/NWRlMTk4NzgxYzNjNDIzOTg2Yzc3YzkyODYxYjNjMzY=/electron_0-1492528465-{JOB-ID}.tar.gz"
    },
    "encryptionEnabled" : false,
    "groupId" : "{PROJECT-ID}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-19T21:14:25Z",
      "increment" : 1
    }
  } ],
  "totalCount" : 2
}