Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

Obtener un snapshot para un servidor de configuración

Importante

Obsoleto cuando se utiliza 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 Obtener una snapshot para un clúster método. Los servidores de configuración deben implementarse como conjuntos de réplicas (también conocidos como CSRS). Para obtener más información, consulta Servidores de configuración de set de réplicas en el Manual del servidor MongoDB.

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}
Nombre
Tipo
Descripción

PROJECT-ID

string

Identificador único del Proyecto que es propietario de la snapshot.

CLUSTER-ID

string

Identificador único del clúster que representa la instantánea.

SNAPSHOT-ID

string

Identificador único de la snapshot.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

false

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:

Nombre
Descripción

status

Código de respuesta HTTP

content

Cuerpo de respuesta esperado

false

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Nombre
Tipo
Descripción

clusterId

ID del clúster que representa la snapshot.

completo

booleano

Indicador de que la snapshot ha sido creada. Esto es false si la tarea de creación de snapshot aún está en curso.

creado

Documento

Los componentes de un timestamp.

created.date

Marca de tiempo

El punto exacto en el que se tomó la snapshot en ISO 8601 formato de fecha y hora 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 doNotDelete está configurado en true, cualquier valor en expires será ignorado.

expira

Marca de tiempo

La fecha en ISO 8601 formato de fecha y hora en UTC después de la cual este/a snapshot puede ser eliminado/a.

Si doNotDelete está configurado en true, se elimina cualquier valor en expires.

Si el valor expires es anterior a la fecha y hora actual, ya no podrá editarse.

ID del grupo

ObjectId

ID del proyecto que posee la snapshot.

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

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 links arreglos en las respuestas incluyen al menos un enlace llamado self. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.

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.

  • Si este valor se establece en denyList, los espacios de nombres en namespaceFilterList.filterList se excluyen de la instantánea.

  • Si este valor se establece en accessList, solo los namespaces en namespaceFilterList.filterList se incluyen en la snapshot.

El valor por defecto es denyList.

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 del 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.masterKeyUUID

ObjectId

El ID de clave maestra KMIP utilizado para cifrar los datos de la snapshot. parts.masterKeyUUID aparece solo si esta snapshot tiene parts.encryptionEnabled : true.

parts.mongodVersion

string

La versión de mongod que se ejecutaba cuando se creó la 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:

  • CONFIG_SERVER

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"
HTTP/1.1 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
HTTP/1.1 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}
{
"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"
} ]
}

Volver

Obtener todo (Servidor de configuración)

En esta página