- API >
- Public API Resources >
- Backup and Restore >
- Restore Jobs >
- Get All Restore Jobs for One Cluster
Get All Restore Jobs for One Cluster¶
On this page
Get all restore jobs for a cluster. CLUSTER-ID
must be the ID of
either a replica set or a sharded cluster.
Note
If you use the BATCH-ID
query parameter, you can retrieve all
restore jobs in the specified batch. When creating a restore job for
a sharded cluster, Ops Manager creates a separate job for each shard, plus
another for the config server. Each of those jobs are part of a
batch. A restore job for a replica set, however, cannot be part of a
batch.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resources¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
GROUP-ID | string | Unique identifier of the group that owns the snapshot. |
CLUSTER-ID | string | Unique identifier of the cluster that the snapshot represents. |
Request Query Parameters¶
Name | Type | Description | Default |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty | boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
envelope | boolean | Flag indicating whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return a list of results, the |
false |
BATCH-ID | string | Unique identifier of the batch. | NONE |
---|
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
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.
Name | Type | Description |
---|---|---|
results | object array | This array includes one object for each item detailed in the results Embedded Document section. |
links | object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one cluster restore job.
Name | Type | Description |
---|---|---|
batchId | string | Unique identifier of the batch to which this restore job belongs. Only present for a restore of a sharded cluster. |
clusterId | string | Unique identifier of the cluster that the restore job represents. Only present for a restore of a cluster. |
created | string | Timestamp in ISO 8601 date and time format in UTC when the restore job was requested. |
delivery | object | Method and details of how the restored snapshot data is delivered. |
delivery.expirationHours | number | Number of hours the download URL is valid once the restore job is complete. Only needed if |
delivery.expires | string | Timestamp in ISO 8601 date and time format in UTC after which the URL is no longer available. Only present if |
delivery.formatName | string | Format in which data from an SCP restore should be written to the destination. Accepted values are:
Only present if |
delivery.hostname | string | Hostname of the server to which the data should be written for an SCP restore. Only present if |
delivery.maxDownloads | number | Number of times the download URL can be used. This must be Only needed if |
delivery.methodName | string | Means by which the data is delivered. Accepted values are:
SCP Restore Deprecated Restore delivery via SCP is a deprecated feature. This feature will be removed in Ops Manager 4.0. |
delivery.port | number | Port to use for Only present if |
delivery.statusName | string | Current status of the downloadable file. Accepted values are:
|
delivery.targetClusterId | string | Unique identifier of the destination cluster to perform the restore job. Only present if |
delivery.targetDirectory | string | Target directory to which the data should be written for an SCP restore. Only present if |
delivery.targetGroupId | string | Unique identifier of the project that contains the destination cluster for the restore job. Only present if |
delivery.url | string | URL from which the restored snapshot data can be downloaded. Only present if |
encryptionEnabled | boolean | Flag indicating whether the restored snapshot data is encrypted. |
groupId | string | Unique identifier of the group that owns the restore job. |
hashes | object array | If the corresponding Note For an |
hashes.fileName | string | Name of the snapshot file that has been hashed. |
hashes.hash | string | Hash of the snapshot file. |
hashes.typeName | string | Hashing algorithm used to compute the hash value. If
present, this value is SHA1 . |
hostId | string | Unique identifier of the config server to which this restore job belongs. Only present for a restore of a mirrored config server (SCCC). |
id | string | Unique identifier of the restore job. |
links | object array | One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification |
masterKeyUUID | string | KMIP master key ID used to encrypt the snapshot data. Only present only if |
pointInTime | boolean | Flag indicating that the job for a PIT restore. |
snapshotId | string | Unique identifier of the snapshot to restore. |
statusName | string | Current status of the job. Accepted values are:
|
timestamp | object | BSON Timestamp of the latest oplog entry in the restored snapshot. |
timestamp.date | string | Timestamp in ISO 8601 date and time format in UTC of the latest oplog entry in the restored snapshot. |
timestamp.increment | number | Order of all operations completed at the latest oplog entry in the restored snapshot. |