Docs Home

/ /

Snapshots

Docs Home

/ /

Copia de seguridad y restauración

Snapshots

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Copia de seguridad y restauración

Snapshots

Obtener un Snapshot para un clúster

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}

Request Parameters

Parámetros de ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
`PROJECT-ID`	string	Requerido	Unique identifier of the project that owns the snapshot.
`CLUSTER-ID`	string	Requerido	Identificador único del clúster que representa la instantánea.
`SNAPSHOT-ID`	string	Requerido	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.	`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: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

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

Respuesta

`Name`	Tipo	Descripción
`clusterId`	string	Identificador único del clúster que representa el snapshot.
`clusterName`	string	Etiqueta que identifica el clúster.
`complete`	booleano	Indicador que indica que se ha creado la snapshot. Esto es `false` si la tarea de creación de instantáneas aún está en curso.
`created`	Documento	Componentes de una marca de tiempo.
`created` `.date`	Marca de tiempo	El tiempo iso8601cuando se tomó el snapshot.
`created` `.increment`	entero	Orden de operación 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 que indica que la instantánea no puede borrarse.
`expires`	Marca de tiempo	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC a las UTC después de lo cual este snapshot se puede borrar. Si `doNotDelete` está configurado en `true`, se elimina cualquier valor en `expires`. Si el valor `expires` es anterior a la fecha y hora actuales, no se puede editar.
`groupId`	string	Unique identifier of the project that owns the snapshot.
`id`	string	Identificador único de la snapshot.
`isPossibly` `Inconsistent`	booleano	Bandera que indica la coherencia de esta snapshot. `isPossiblyInconsistent` aparece únicamente para las instantáneas de clúster particionado. To take a snapshot of a sharded cluster in a consistent state, the Backup 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. Si esto sucede, el snapshot podría encontrarse en un estado inconsistente (por ejemplo, es posible que las migraciones de fragmentos estén en curso).
`lastOplog` `AppliedTimestamp`	Documento	Se aplicaron los componentes del timestamp de la última entrada de oplog.
`lastOplog` `AppliedTimestamp` `.date`	Marca de tiempo	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC a las UTC cuando se aplicó el último oplog.
`lastOplog` `AppliedTimestamp` `.increment`	entero	Orden de la operación en la que se aplicó el último oplog en este exacto punto en el tiempo. Para aprender cómo funcionan las marcas de tiempo en MongoDB, consulta Marcas de tiempo.
`links`	objeto arreglo	Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos `links` en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLse explican en la Especificación de enlaces web.
`namespaceFilterList`	Objeto	espacios de nombres que están incluidos o excluidos en este snapshot.
`namespaceFilterList` `.filterList`	arreglo de string	Lista separada por comas de cualquier combinación de bases de datos o namespaces que estén exclusivamente incluidos o explícitamente excluidos del snapshot. El valor por defecto es un arreglo vacío (`[]`).
`namespaceFilterList` `.filterType`	string	Etiqueta que determina cómo se filtran los espacios de nombres para este snapshot. Si este valor se establece en `blacklist`, los espacios de nombres en `namespaceFilterList.filterList` se excluyen de la instantánea. Si este valor se establece en `whitelist`, solo los namespaces en `namespaceFilterList.filterList` se incluyen en la snapshot. El valor por defecto es `blacklist`.
`missingShards`	Arreglo de objetos	Lista de particiones que le faltan a la snapshot. `missingShards` aparece solo para instantáneas de clústeres fragmentados. In steady state, this array is empty. If the Backup 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 `self` link.
`missingShards` `.id`	string	Identificador único de la particiónfaltante.
`missingShards` `.groupId`	string	Identificador único del Proyecto que posee la particiónfaltante.
`missingShards` `.typeName`	string	Tipo de servidor que representa la partición que falta: `CONFIG_SERVER_REPLICA_SET` `REPLICA_SET` `CONFIG_SHARD_REPLICA_SET`
`missingShards` `.clusterName`	string	Nombre del clúster para la particiónfaltante.
`missingShards` `.shardName`	string	Nombre de la particiónque falta.
`missingShards` `.replicaSetName`	string	Nombre del set de réplicas en la particiónque falta.
`missingShards` `.lastHeartbeat`	Marca de tiempo	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC a las UTC cuando se recibió el último latido de la particiónque falta.
`parts`	Arreglo de objetos	Partes individuales que conforman la snapshotcompleta. Para un set de réplicas, este arreglo contiene un único documento. Para un cluster particionado, este arreglo contiene un documento por cada partición más un documento para el servidor de configuración.
`parts` `.clusterId`	string	Identificador único del set de réplicas.
`parts` `.completedTime`	string	Fecha y hora en que se completó la snapshot.
`parts` `.compressionSetting`	string	Método de compresión para la snapshot.
`parts` `.dataSizeBytes`	Número	Tamaño total de los datos en el 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	Tamaño total de los archivos de datos en bytes.
`parts` `.machineId`	string	Nombre del host y puerto que indican el nodo en el que MongoDB nube creó la snapshot.
`parts` `.masterKeyUUID`	string	ID de clave maestra KMIP utilizado para cifrar los datos del snapshot. `parts.masterKeyUUID` aparece solo si este snapshot tiene `parts.encryptionEnabled : true`.
`parts` `.mongodVersion`	string	Version of `mongod` that the replica set primary was running when the snapshot was created.
`parts` `.replicaSetName`	string	Nombre del set de réplicas.
`parts` `.replicaState`	string	El rol del nodo en el momento en que comenzó el proceso de snapshot.
`parts` `.storageSizeBytes`	Número	Tamaño total del espacio asignado para el almacenamiento de documentos.
`parts` `.typeName`	string	Tipo de servidor que representa la pieza: `REPLICA_SET` `CONFIG_SERVER_REPLICA_SET` `CONFIG_SHARD_REPLICA_SET`

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}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}?pretty=true"

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

{
  "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}",
  "lastOplogAppliedTimestamp" : {
    "date" : "2017-08-21T09:14:51Z",
    "increment" : 1
  },
  "links" : [ {
    "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}",
    "rel" : "self"
  } ],
  "namespaceFilterList" : {
    "filterList" : [ ],
    "filterType" : "denylist"
  },
  "parts" : [ {
    "clusterId" : "{CLUSTER-ID}",
    "compressionSetting" : "GZIP",
    "dataSizeBytes" : 503779557,
    "encryptionEnabled" : false,
    "fileSizeBytes" : 2855605344,
    "mongodVersion" : "4.0.9",
    "replicaSetName" : "proton",
    "storageSizeBytes" : 547516416,
    "typeName" : "REPLICA_SET"
  } ]
}

Volver

Obtener todos (clúster)

Cambiar Expiración