Get All Snapshots for One Config Server
On this page
Important
Deprecated when using MongoDB 3.4
As of MongoDB 3.4, mirrored config server deployments (also known as SCCC) are no longer supported. The following API method works with SCCC config servers only. Replica set config servers (also known as CSRS) use the Get All Snapshots for One Cluster method. To learn how to convert your config servers from SCCC to a CSRS, see Upgrade Config Servers to Replica Set in the MongoDB Server Manual.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots
Request Parameters
Request Path Parameters
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. |
|
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. |
|
pretty | boolean | Optional | Flag that indicates whether the response body should be in a prettyprint format. |
|
envelope | boolean | Optional | Flag that 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 a list of results, the |
|
backupJobsEnabledOnly | boolean | Optional | Flag indicating whether to exclude daemons not enabled for
backing up databases from the response. Set this to |
|
Request Body Parameters
This endpoint doesn't 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 |
---|---|---|
| array | Array includes one object for each item detailed in the
|
| array | Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
| number | Integer 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 snapshot.
Name | Type | Description |
---|---|---|
clusterId | ID of the cluster the snapshot represents. | |
complete | boolean | Indicator that the snapshot has been created. This is
|
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. If |
expires | timestamp | |
groupId | objectId | |
id | objectId | ID of the snapshot. |
lastOplogAppliedTimestamp | document | The components of the timestamp of the last oplog entry was applied. |
lastOplogAppliedTimestamp.date | timestamp | |
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. All
|
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 |
parts | object array | The individual parts that comprise the complete snapshot. This array contains a single document. |
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.hostId | string | ID of a config server. |
parts.masterKeyUUID | objectId | The KMIP
master key ID used to encrypt the snapshot data.
|
parts.mongodVersion | string | The version of |
parts.storageSizeBytes | number | The total size of space allocated for document storage. |
parts.typeName | string | The type of server that the part represents:
|
Example Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true"
Example Response
Response Header
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}
Response Body
{ "links" : [ { "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "clusterId" : "{CLUSTER-ID}", "complete" : true, "created" : { "date" : "2016-08-21T23:47:38Z", "increment" : 1 }, "doNotDelete" : false, "expires" : "2017-08-20T23:47:38Z", "groupId" : "{PROJECT-ID}", "id" : "{SNAPSHOT-ID}", "links" : [ { "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}", "rel" : "self" } ], "namespaceFilterList" : { "filterList" : [ ], "filterType" : "blacklist" }, "parts" : [ { "clusterId" : "{CLUSTER-ID}", "compressionSetting" : "GZIP", "dataSizeBytes" : 503779557, "encryptionEnabled" : false, "fileSizeBytes" : 2855605344, "mongodVersion" : "4.0.9", "replicaSetName" : "proton", "storageSizeBytes" : 547516416, "typeName" : "REPLICA_SET" } ] }, { } ], "totalCount" : 28 }