- API >
- Public API Resources >
- Backup and Restore >
- Snapshots >
- Get One Snapshot for One Cluster
Get One Snapshot for One Cluster¶
On this page
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Parameters¶
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. |
SNAPSHOT-ID | string | Unique identifier of the snapshot. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Indicates 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 one result, the response body includes:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
clusterId | objectId | ID of the cluster the snapshot represents. |
complete | boolean | Indicator that the snapshot has been created. This is
false if the snapshot creation job is still in progress. |
created | document | The components of a timestamp. |
created.date | timestamp | The exact point in time when the snapshot was taken in ISO 8601 date and time format at UTC. |
created.increment | integer | The operation order in which this snapshot took place at this exact point in time. To learn how timestamps work in MongoDB, see Timestamps. |
doNotDelete | boolean | Indicator that the snapshot cannot be deleted. |
expires | timestamp | The date in ISO 8601 date and time format at UTC after which this snapshot can be deleted. If If the |
groupId | objectId | ID of the group that owns the snapshot. |
id | objectId | ID of the snapshot. |
isPossiblyInconsistent | boolean | Indicator of the consistency of this snapshot. Note This appears for sharded cluster snapshots only. To take a snapshot of a sharded cluster in a consistent state, the Backup Agent temporarily turns off the balancer before creating the snapshot. In some cases, it cannot turn off the balancer in a timely manner. The snapshot is then created with the balancer still running. If this happens, the snapshot may be in an inconsistent state (e.g., chunk migrations may be in progress). |
lastOplogAppliedTimestamp | document | The components of the timestamp of the last oplog entry was applied. |
lastOplogAppliedTimestamp.date | timestamp | The exact point in time when the last oplog was applied in ISO 8601 date and time format at UTC. |
lastOplogAppliedTimestamp.increment | integer | The operation order in which last oplog was applied at this exact point in time. To learn how timestamps work in MongoDB, see Timestamps. |
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 |
namespaceFilterList | object array | The namespaces that are included or excluded from this snapshot. |
namespaceFilterList.filterList | string array | A comma-separated list of any combination of databases or namespaces that are exclusively included or explicitly excluded from the snapshot. The default value is an empty array ( |
namespaceFilterList.filterType | string | A value that determines how namespaces are filtered for this snapshot.
The default value is |
missingShards | object array | List of shards that the snapshot is missing. Note This appears for sharded cluster snapshots only. In steady state, this array is empty. If the Backup Agent
cannot connect to a shard when a snapshot is created, the
shard is omitted from the snapshot. Each document in the
array is a cluster document containing a |
missingShards.id | objectId | ID of the missing shard. |
missingShards.groupId | objectId | ID of the group that owns the missing shard. |
missingShards.typeName | string | The type of server that the missing shard represents:
|
missingShards.clusterName | string | The name of the cluster for the missing shard. |
missingShards.shardName | string | The name of the missing shard. |
missingShards.replicaSetName | string | Name of the replica set in the missing shard. |
missingShards.lastHeartbeat | timestamp | The exact point in time in ISO 8601 date and time format at UTC when the last heartbeat was received from the missing shard. |
parts | object array | The individual parts that comprise the complete snapshot.
|
parts.clusterId | objectId | ID of the replica set. |
parts.compressionSetting | string | Method of compression for the snapshot. |
parts.dataSizeBytes | number | The total size of the data in the snapshot in bytes. |
parts.encryptionEnabled | boolean | Indicator of the state of encryption of the snapshot data. |
parts.fileSizeBytes | number | The total size of the data files in bytes. |
parts.masterKeyUUID | objectId | The KMIP master key ID used to encrypt the snapshot data. Note This appears only if this snapshot has
|
parts.mongodVersion | string | The version of mongod that the replica set
primary was running when the snapshot was
created. |
parts.replicaSetName | string | Name of the replica set. |
parts.storageSizeBytes | number | The total size of space allocated for document storage. |
parts.typeName | string | The type of server that the part represents:
|