ベース URL: https://cloud.mongodb.com/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/restorableTimeRanges
プロジェクト内のバックアップ可能なレプリカセットまたはシャーディングされたクラスターの復元可能な時間範囲を返します。各リストア可能な時間範囲は、Cloud Manager が安全にリストアできる oplog 履歴の連続したウィンドウを表します。
必要な権限
このエンドポイントを呼び出すには、 Project Backup Admin または Organization Read Only ロールが必要です。
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | クラスターを所有するプロジェクトを識別する一意の 24 桁の 16 進数 string。 |
| string | 復元可能な時間範囲を返すバックアップ有効なクラスターを識別する一意な 24 桁の 16 進数 string。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ボディには、リストア可能な時間範囲の配列が含まれます。レプリカセットの場合、各要素には次のフィールドが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| BSONタイムスタンプ | この復元可能範囲で最も早い時間の点。この値は、 |
| BSONタイムスタンプ | この復元可能な範囲の最新の点。Cloud Manager は、この範囲で、 |
| string | この範囲に関連付けられたスナップショットまたは clustershot を識別する一意の 24 桁の 16 進数 string。 |
シャーディングされたクラスターの場合、各要素には以下も含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| integer | この復元可能な時間範囲に参加するシャードの数。 |
| string | シャーディングされたクラスターが埋め込み型のコンフィギュレーションサーバー配置を使用しているか、専用のコンフィギュレーションサーバー配置を使用しているかを示す、人間が判読できるラベル。 |
Cloud Manager は、復元可能な時間範囲を最も早い開始時間から最も新しい開始時間への順で返します。
リクエストの例
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}/clusters/{CLUSTER-ID}/restoreJobs/restorableTimeRanges?pretty=true"
応答例
応答ヘッダー
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
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}
レスポンス本体
[ { "end" : { "date" : "2021-07-17T19:00:00Z", "increment" : 1 }, "snapshotId" : "{SNAPSHOT-ID}", "start" : { "date" : "2021-07-14T00:00:00Z", "increment" : 1 } } ]