Importante
Obsoleto al usar MongoDB 3.4
A partir de MongoDB 3.4, las implementaciones de servidores de configuración espejados (también conocidos como SCCC) ya no se admiten. El siguiente método de API funciona solo con servidores de configuración SCCC. Los set de réplicas de servidor de configuración (también conocidos como CSRS) utilizan el Método Obtener una instantánea para un clúster. Los servidores de configuración deben implementarse como conjuntos de réplicas (también conocidos como CSRS). Para obtener más información, consulte Servidores de configuración de conjuntos de réplicas en el Manual del servidor MongoDB.
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}
Request Parameters
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | |
CLUSTER-ID | string | Identificador único del clúster que representa la instantánea. |
SNAPSHOT-ID | string | Identificador único de la snapshot. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
clusterId | ID del clúster que representa la snapshot. | |
completar | booleano | Indicador de que la snapshot ha sido creada. Esto es |
creado | Documento | Los componentes de un timestamp. |
created.date | fecha y hora | El punto exacto en el que se tomó la instantánea en formato de fecha y hora ISO 8601 en UTC. |
created.increment | entero | El orden de operación en el que se realizó esta instantánea en este momento exacto. Para saber cómo funcionan las marcas de tiempo en MongoDB, consulte Marcas de tiempo. |
doNotDelete | booleano | Indicador de que el snapshot no puede ser borrado. Si |
expira | fecha y hora | |
ID del grupo | ObjectId | ID del proyecto propietario de la instantánea. |
ID | ObjectId | ID del snapshot. |
última marca de tiempo aplicada del registro de operaciones | Documento | Se aplicaron los componentes de la marca de tiempo de la última entrada del oplog. |
lastOplogAppliedTimestamp.date | fecha y hora | El punto exacto en el tiempo en el que se aplicó el último oplog en el formato de fecha y hora ISO 8601 en UTC. |
lastOplogAppliedTimestamp.increment | entero | El orden de operaciones en el que se aplicó el último oplog en este punto exacto en el tiempo. Para aprender cómo funcionan las marcas de tiempo en MongoDB, consulta Marcas de tiempo. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los |
namespaceFilterList | objeto arreglo | Los namespaces que están incluidos o excluidos en esta snapshot. |
ListaDeFiltrosDeEspacioDeNombres.ListaDeFiltros | arreglo de string | Una lista separada por comas de cualquier combinación de bases de datos o espacios de nombres que se incluyan exclusivamente o se excluyan explícitamente de la snapshot. El valor por defecto es un arreglo vacío ( |
Lista de filtros de espacio de nombres.tipo de filtro | string | Un valor que determina cómo se filtran los espacios de nombres para esta snapshot.
El valor por defecto es |
piezas | objeto arreglo | Las partes individuales que conforman la snapshot completa. Este arreglo contiene un solo documento. |
Tamaño de datos | Número | El tamaño total de los datos en la snapshot en bytes. |
parts.encryptionEnabled | booleano | Indicador del estado de cifrado de los datos de la instantánea. |
parts.fileSizeBytes | Número | El tamaño total de los archivos de datos en bytes. |
parts.hostId | string | ID de un servidor de configuración. |
parts.masterKeyUUID | ObjectId | El ID de clave maestra KMIP utilizado para cifrar los datos de la snapshot. |
partes.mongodVersion | string | La versión de |
parts.storageSizeBytes | Número | El tamaño total del espacio asignado para el almacenamiento de documentos. |
partes.typeName | string | El tipo de servidor que la parte representa:
|
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true"
Respuesta de ejemplo
Encabezado de respuesta
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}
Respuesta del cuerpo
{ "CLUSTER-ID" : "{CLUSTER-ID}", "complete" : true, "created" : { "date" : "2016-08-21T23:47:38Z", "increment" : 1 }, "doNotDelete" : false, "expires" : "2017-08-20T23:47:38Z", "GROUP-ID" : "{PROJECT-ID}", "HOST-ID" : "{HOST-ID}", "id" : "{SNAPSHOT-ID}", "lastOplogAppliedTimestamp" : { "date" : "2017-08-21T09:14:51Z", "increment" : 1 }, "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}", "rel" : "self" } ], "namespaceFilterList" : { "filterList" : [ ], "filterType" : "denyList" }, "parts" : [ { "dataSizeBytes" : 503779557, "encryptionEnabled" : false, "fileSizeBytes" : 2855605344, "HOST-ID" : "{HOST-ID}", "mongodVersion" : "4.0.9", "storageSizeBytes" : 547516416, "typeName" : "REPLICA_SET" } ] }