ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/restorableTimeRanges
プロジェクト内のバックアップが有効なレプリカセットまたはシャーディングされたクラスターの復元可能な時間範囲を返します。復元可能な各時間範囲は、Ops Manager が安全に復元できるoplog履歴の連続したウィンドウを表します。
必要な権限
Global Backup Adminこのエンドポイントを呼び出すには、Global Read Only 、Project Backup Admin 、または ロールが必要です。
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | クラスターを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。 |
| string | 返却対象の復元可能な時間範囲を持つバックアップ対応クラスターを識別する一意な 24 桁の 16 進数文字列。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体が pretty-print 形式であるかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
レスポンス本体には、復元可能な時間範囲の配列が含まれています。レプリカセットの場合、各要素には次のフィールドが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| BSONタイムスタンプ | この復元可能な範囲内の過去の点インタイム。この値は、 |
| BSONタイムスタンプ | この復元可能な範囲内の最新の点MongoDB Ops Manager は、この範囲の場合、 |
| string | この範囲に関連付けられているスナップショットまたはクラスターショットを識別する一意の 24 桁の 16 進数文字列。 |
シャーディングされたクラスターの場合、各要素には次のものも含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| integer | この復元可能な時間範囲に参加するシャードの数。 |
| string | シャーディングされたクラスターが埋め込みコンフィギュレーションサーバーまたは専用コンフィギュレーションサーバーのどちらの配置を使用しているかを示す、人間が判読可能なラベル。 |
Ops Manager は、最も近い開始時間から最も新しい開始時間の順に復元可能な時間範囲を返します。
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://{OPSMANAGER-HOST}:{PORT}/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 } } ]