/ /

Snapshots

Docs Home

/ /

Copia de seguridad y restauración

Copia de seguridad y restauración

Snapshots

Cambie la Expiración de un snapshot

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

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

Resource

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

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	Identificador único del proyecto propietario de la instantánea.
CLUSTER-ID	string	Identificador único del clúster que representa la instantánea.
ID DE INSTANTÁNEA	string	Identificador único de la snapshot.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

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 un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
NoEliminar	booleano	Indicador de que la instantánea no se puede eliminar. IMPORTANTE: No se puede establecer `doNotDelete` `true` en y una marca de tiempo para `expires` en la misma solicitud. Si lo hace, Cloud Manager devuelve un error: `Cannot modify snapshot because of invalid fields.`
expira	fecha y hora	La fecha en formato de fecha y hora ISO 8601 en UTC después de la cual se puede eliminar esta instantánea. Si `doNotDelete` se establece en `true`, se elimina cualquier valor existente en `expires`. Si `expires` se configura como una marca de tiempo igual o anterior a la fecha y hora actuales, Cloud Manager elimina la instantánea en cuanto tenga la oportunidad. No se garantiza que la instantánea se elimine inmediatamente. Si la marca de tiempo `expires` actual ya ha pasado, no se puede editar.

Respuesta

`Name`	Tipo	Descripción
`clusterId`	string	Identificador único del clúster que representa la instantánea.
`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 `denyList`, los espacios de nombres en `namespaceFilterList.filterList` se excluyen de la instantánea. Si este valor se establece en `accessList`, solo se incluyen en la instantánea los espacios de nombres en `namespaceFilterList.filterList`. El valor por defecto es `denyList`.
`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` `.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` `.fileSizeBytes`	Número	Tamaño total de los archivos de datos en bytes.
`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` `.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`

`links` Arreglo

El arreglo links incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLs se explican en la Especificación de Enlace Web

Relación	Descripción
yo	El punto final de URL para este recurso.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}?pretty=true" \
     --data '
     {
       "doNotDelete": 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

{
  "id" : "{SNAPSHOT-ID}",
  "CLUSTER-ID" : "{CLUSTER-ID}",
  "complete" : true,
  "created" : {
    "date" : "2014-07-09T15:24:37Z",
    "increment" : 1
  },
  "doNotDelete" : true,
  "GROUP-ID" : "{PROJECT-ID}",
  "lastOplogAppliedTimestamp" : {
    "date" : "2017-08-21T09:14:51Z",
    "increment" : 1
  },
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}",
   "rel" : "self"
  } ],
  "namespaceFilterList" : {
    "filterList" : [ ],
    "filterType" : "denyList"
  },
  "parts" : [ {
    "CLUSTER-ID" : "{CLUSTER-ID}",
    "dataSizeBytes" : 17344,
    "fileSizeBytes" : 67108864,
    "mongodVersion" : "2.6.3",
    "replicaSetName" : "rs0",
    "storageSizeBytes" : 10502144,
    "typeName" : "REPLICA_SET"
  } ],
}

Volver

Consigue uno (grupo)

Remover uno

Resource

Request Parameters

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

links Arreglo

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`links` Arreglo