1 つのクラスターの 1 つの復元ジョブを取得
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | 復元ジョブを所有するプロジェクトの一意の識別子。 |
CLUSTER-ID | string | 復元ジョブが表すクラスターの一意の識別子。 |
JOB-ID | string | 復元ジョブの一意の識別子。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
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/{JOB-ID}?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}
レスポンス本体
{ "batchId" : "{BATCH-ID}", "clusterId" : "{CLUSTER-ID}", "created" : "2016-03-04T22:07:27Z", "delivery" : { "expirationHours" : 1, "expires" : "2016-03-04T23:07:27Z", "maxDownloads" : 1, "methodName" : "HTTP", "statusName" : "EXPIRED", "url" : "https://backup-host.example.com/backup/restore/v2/pull/{JOB-ID}/1976673072885966399/electron_0-1456098690-{JOB-ID}.tar.gz" }, "encryptionEnabled" : false, "groupId" : "{PROJECT-ID}", "id" : "{JOB-ID}", "links" : [ { } ], "pointInTime" : false, "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2017-04-19T21:14:25Z", "increment" : 1 } }