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 todas las instantáneas de un clúster

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

Resource

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

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	Identificador único de la proyecto que posee la instantánea.
CLUSTER-ID	string	Identificador único del clúster que representa la instantánea.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.	`false`
envolvente	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure `envelope : true` en la consulta. Para los puntos finales que devuelven una lista de resultados, el objeto `results` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`
completado	string	Opcional	Cadena que indica si se deben devolver capturas completas o incompletas: `true`: Devolver solo instantáneas completadas `false`: Devolver solo instantáneas incompletas `all`: Devuelve instantáneas completadas e incompletas	`true`

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en el Sección`results` de documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es un almacén de sincronización.

`Name`	Tipo	Descripción
`clusterId`	string	Identificador único del clúster que representa la instantánea.
`clusterName`	string	Etiqueta que identifica el cluster.
`complete`	booleano	Indicador que indica que se ha creado la instantánea. Este valor es `false` si la tarea de creación de la instantánea aún está en curso.
`created`	Documento	Componentes de una marca de tiempo.
`created` `.date`	fecha y hora	iso8601-tiempo en el que se tomó la instantánea.
`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	Bandera que indica que la instantánea no se puede eliminar.
`expires`	fecha y hora	Marca de tiempo en formato 8601 de fecha y hora ISO en UTC a las UTC después de las cuales se puede eliminar esta instantánea. 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	Identificador único del proyecto propietario de la instantánea.
`id`	string	Identificador único de la snapshot.
`isPossibly` `Inconsistent`	booleano	Bandera que indica la consistencia de esta instantánea. `isPossiblyInconsistent` aparece solo para instantáneas de clúster fragmentado. Para tomar una instantánea de un clúster fragmentado en un estado consistente, la copia de seguridad desactiva temporalmente el balanceador antes de crearla. En algunos casos, no puede desactivar el balanceador a tiempo. La instantánea se crea entonces con el balanceador aún en ejecución. Si esto sucede, la instantánea puede estar en un estado inconsistente (por ejemplo, es posible que haya migraciones de fragmentos en curso).
`lastOplog` `AppliedTimestamp`	Documento	Se aplicaron componentes de la marca de tiempo de la última entrada del registro de operaciones.
`lastOplog` `AppliedTimestamp` `.date`	fecha y hora	Marca de tiempo en formato 8601 de fecha y hora ISO en UTC en el momento UTC en que se aplicó el último registro de operaciones.
`lastOplog` `AppliedTimestamp` `.increment`	entero	Orden de operación en el que se aplicó el último registro de operaciones en este momento exacto. Para saber cómo funcionan las marcas de tiempo en MongoDB, consulte Marcas de tiempo.
`links`	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`namespaceFilterList`	Objeto	espacios de nombres que están incluidos o excluidos de esta instantánea.
`namespaceFilterList` `.filterList`	matriz de cadenas	Lista separada por comas de cualquier combinación de bases de datos o espacios de nombres que se incluyen exclusivamente o se excluyen explícitamente de la instantánea. El valor predeterminado es una matriz vacía (`[]`).
`namespaceFilterList` `.filterType`	string	Etiqueta que determina cómo se filtran los espacios de nombres para esta instantánea. 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 se incluyen en la instantánea los espacios de nombres en `namespaceFilterList.filterList`. El valor por defecto es `blacklist`.
`missingShards`	matriz de objetos	Lista de particiones que le faltan a la snapshot. `missingShards` aparece solo para instantáneas de clústeres fragmentados. En estado estable, esta matriz está vacía. Si la copia de seguridad no puede conectarse a un fragmento al crear una instantánea, este se omite. Cada documento de la matriz es un documento de clúster que contiene un `self` enlace.
`missingShards` `.id`	string	Identificador único del fragmento faltante.
`missingShards` `.groupId`	string	Identificador único del proyecto que posee el fragmento faltante.
`missingShards` `.typeName`	string	Tipo de servidor que representa el fragmento faltante: `CONFIG_SERVER_REPLICA_SET` `REPLICA_SET` `CONFIG_SHARD_REPLICA_SET`
`missingShards` `.clusterName`	string	Nombre del clúster del fragmento faltante.
`missingShards` `.shardName`	string	Nombre de la particiónque falta.
`missingShards` `.replicaSetName`	string	Nombre del conjunto de réplicas en el fragmento faltante.
`missingShards` `.lastHeartbeat`	fecha y hora	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC en el momento en que se recibió el último latido del fragmento faltante.
`parts`	matriz de objetos	Partes individuales que componen la instantánea completa. Para un conjunto de réplicas, esta matriz contiene un solo documento. Para un clúster fragmentado, esta matriz contiene un documento para cada fragmento más un documento para el servidor de configuración.
`parts` `.clusterId`	string	Identificador único del conjunto de réplicas.
`parts` `.completedTime`	string	Fecha y hora en que se completó la instantánea.
`parts` `.compressionSetting`	string	Método de compresión para la instantánea.
`parts` `.dataSizeBytes`	Número	Tamaño total de los datos en la instantánea en bytes.
`parts` `.encryptionEnabled`	booleano	Indicador del estado de cifrado de los datos de la instantánea.
`parts` `.fcv`	string	Número que indica la versión de compatibilidad de características de MongoDB que el conjunto de réplicas principal ejecutó cuando MongoDB Cloud creó la instantánea.
`parts` `.fileSizeBytes`	Número	Tamaño total de los archivos de datos en bytes.
`parts` `.machineId`	string	Nombre de host y puerto que indican el nodo en el que MongoDB Cloud creó la instantánea.
`parts` `.masterKeyUUID`	string	ID de clavemaestra KMIP utilizada para cifrar los datos de la instantánea. `parts.masterKeyUUID` aparece solo si esta instantánea `parts.encryptionEnabled : true` tiene.
`parts` `.mongodVersion`	string	Versión de que `mongod` el conjunto de réplicas principal estaba ejecutando cuando se creó la instantánea.
`parts` `.replicaSetName`	string	Nombre del conjunto de réplicas.
`parts` `.replicaState`	string	El papel del nodo en el momento en que comenzó el proceso de instantánea.
`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`

Ejemplo de solicitud

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?pretty=true"

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "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}",
    "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" : "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
}

Volver

Snapshots

Consigue uno (grupo)

Resource

Request Parameters

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado