1 つのクラスターのすべての復元ジョブを取得
項目一覧
クラスターのすべての復元ジョブを取得します。 CLUSTER-IDは、 レプリカセットまたはシャーディングされたクラスターのいずれかの ID である必要があります。
注意
BATCH-IDクエリ パラメータを使用すると、指定されたバッチ内のすべての復元ジョブを検索できます。 シャーディングされたクラスターの復元ジョブを作成する場合、 MongoDB Ops Managerはシャードごとに個別のジョブを作成し、さらにコンフィギュレーションサーバー用に別のジョブを作成します。 これらの各ジョブはバッチの一部です。 ただし、レプリカセットの復元ジョブをバッチの一部にすることはできません。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
リソース
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?batchId={BATCH-ID}
リクエスト パス パラメーター
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
バッチ ID | string | NONE |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
results | 配列 | 配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。 |
links | 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
totalCount | 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのクラスター復元ジョブです。
名前 | タイプ | 説明 |
|---|---|---|
batchId | string | 条件付き: シャーディングされたクラスターのみ。 この復元ジョブが属するバッチの一意の識別子。 |
clusterId | string | |
作成済み | string | ISO8601 のタイムスタンプ 復元ジョブが要求されたときの日付と時刻形式（ UTC） 。 |
delivery | オブジェクト | 復元されたスナップショットデータの配信方法と詳細。 |
delivery.expirationHours | 数値 | 条件付き: "delivery.methodName" : "HTTP"。復元ジョブが完了してからダウンロードURLが有効な時間数。 |
delivery.expires | string | |
delivery.maxDownloads | 数値 | 条件付き: "delivery.methodName" : "HTTP"。ダウンロードURLを使用できる回数。 これは1以上である必要があります。 |
delivery.methodName | string | データが配信される方法を意味します。 指定できる値は以下のとおりです。
重要SCP経由の復元配信はMongoDB Ops Manager 4.0 で削除されました。 |
delivery.statusName | string | ダウンロード可能な ファイルの現在のステータス。 Accepted values are:
|
delivery.url | string | |
encryptionEnabled | ブール値 | 復元されたスナップショットデータが暗号化されているかどうかを示すフラグ。 |
グループ ID | string | 復元ジョブを所有するグループの一意の識別子。 |
ハッシュ | オブジェクト配列 | 対応する
|
hashs.fileName | string | ハッシュされたスナップショット ファイルの名前。 |
ハッシュ。 | string | スナップショット ファイルのハッシュ。 |
hashs.typeName | string | ハッシュ値を計算するために使用されるハッシュ アルゴリズム。 存在する場合、この値は SHA1です。 |
hostId | string | |
id | string | 復元ジョブの一意の識別子。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
マスターキー UUID | string | |
pointInTime | ブール値 | PIT 復元のジョブがPIT復元のジョブであることを示すフラグ。 |
snapshotId | string | 復元するスナップショットの一意の識別子。 |
statusName | string | ジョブの現在のステータス。 指定できる値は以下のとおりです。
|
タイムスタンプ | オブジェクト | スナップショットが作成されたときのoplogエントリのタイムスタンプ。 |
timestamp.date | string | ISO8601 のタイムスタンプ 復元されたスナップショット内の最新の oplog エントリーの UTC 形式の日付と時刻形式。 |
timestamp.increment | string | 復元されたスナップショット内の最新の oplog エントリで完了したすべての操作の順序。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?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}
レスポンス本体
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}", "rel" : "self" } ], "pointInTime" : false, "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://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}", "rel" : "self" } ], "pointInTime" : false, "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2017-04-19T21:14:25Z", "increment" : 1 } } ], "totalCount" : 2 }