Importante
Obsoleto cuando se utiliza MongoDB 3.4
A partir de MongoDB 3.4, las implementaciones de servidores de configuración reflejados (también conocidas como SCCC) ya no son compatibles. El siguiente método de API funciona únicamente con servidores de configuración SCCC. Los servidores de configuración del conjunto de réplicas (también conocidos como CSRS) usan el método Obtener una snapshot para un clúster. Los servidores de configuración deben implementarse como sets de réplicas (también conocidos como CSRS). Para más información, consulta set de réplicas Config Servers en el Manual del Servidor MongoDB.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}
Request Parameters
Parámetros de 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 | Flag indicating whether the response body is in a prettyprint format. |
|
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. | |
Nombre del clúster | string | Etiqueta que identifica el clúster. |
completo | booleano | Indicador de que la snapshot ha sido creada. Esto es |
creado | Documento | Los componentes de un timestamp. |
created.date | Marca de tiempo | El punto exacto en el que se tomó la snapshot en formato de fecha y hora ISO 8601 en UTC. |
created.increment | entero | El orden de las operaciones en el que este snapshot tuvo lugar en este punto exacto en el tiempo. Para aprender cómo funcionan las marcas de tiempo en MongoDB, consulta Marcas de tiempo. |
doNotDelete | booleano | Indicador de que el snapshot no puede ser borrado. Si |
expira | Marca de tiempo | |
ID del grupo | ObjectId | |
ID | ObjectId | ID del snapshot. |
lastOplogAppliedTimestamp | Documento | Se aplicaron los componentes de la marca de tiempo de la última entrada del oplog. |
lastOplogAppliedTimestamp.date | Marca de tiempo | |
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 o recursos relacionados. Todos los arreglos |
namespaceFilterList | objeto arreglo | Los namespaces que están incluidos o excluidos en esta snapshot. |
namespaceFilterList.filterList | 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 ( |
namespaceFilterList.filterType | 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. |
parts.completedTime | string | Fecha y hora en que se completó la snapshot. |
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 del snapshot. |
parts.fcv | string | Número que indica la compatibilidad de características entre versiones de MongoDB que ejecutó el nodo primario del set de réplicas cuando MongoDB Cloud creó la snapshot. |
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.machineId | string | Nombre del host y puerto que indican el nodo en el que MongoDB nube creó la snapshot. |
parts.masterKeyUUID | ObjectId | El ID de clave maestra de KMIP utilizado para cifrar los datos del snapshot. |
parts.mongodVersion | string | La versión de |
parts.replicaState | string | El rol del nodo en el momento en que comenzó el proceso de snapshot. |
parts.storageSizeBytes | Número | El tamaño total del espacio asignado para el almacenamiento de documentos. |
parts.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://{opsManagerHost}:{port}/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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}", "rel" : "self" } ], "namespaceFilterList" : { "filterList" : [ ], "filterType" : "blacklist" }, "parts" : [ { "dataSizeBytes" : 503779557, "encryptionEnabled" : false, "fileSizeBytes" : 2855605344, "HOST-ID" : "{HOST-ID}", "mongodVersion" : "4.0.9", "storageSizeBytes" : 547516416, "typeName" : "REPLICA_SET" } ] }