/ /

Configuraciones de copia de seguridad

Docs Home

/ /

Copia de seguridad y restauración

Configuraciones de copia de seguridad

Copia de seguridad y restauración

Configuraciones de copia de seguridad

Actualizar Una Configuración de copia de seguridad

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal como se indica en el documento.

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

Resource

PATCH /groups/{projectId}/backupConfigs/{clusterId}

Request Parameters

Parámetros de ruta de solicitud

Path Parameter	Tipo	Necesidad	Descripción
ID del proyecto	string	Requerido	Secuencia única de 24 dígitos hexadecimales que identifica el Proyecto que contiene el clúster con la configuración de copia de seguridad que se desea cambiar.
clusterId	string	Requerido	string única de 24 dígitos hexadecimales que identifica el clúster cuya configuración de copia de seguridad desea modificar.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure 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

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
authMechanismName	string	Condicional	Mecanismo de autenticación necesario para conectarse a la base de datos fuente de sincronización. Cloud Manager requiere este parámetro si el almacén de sincronización utiliza autenticación. Cloud Manager acepta: `MONGODB_CR` (Esto cubre SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-CR). `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
espacios de nombres excluidos	Arreglo de cadenas	Condicional	Cloud Manager acepta este parámetro para tareas de copia de seguridad que ejecutan MongoDB `FCV` 4.0 o anterior. Cloud Manager ignora este parámetro cuando respalda bases de datos de MongoDB que ejecutan compatibilidad de características entre versiones 4.2 o posterior. Lista de nombres de bases de datos y colecciones a omitir de la copia de seguridad. Cada string representa un namespace. Los espacios de nombres utilizan el formato {database} o {database}.{collection}. Este parámetro debe cumplir con las siguientes condiciones: Cloud Manager acepta este parámetro o includedNamespaces, pero no ambos. Cloud Manager requiere la nueva lista completa de nombres de espacio excluidos, incluidos los que ya se encuentran en el arreglo. Si tu nueva lista remueve algún namespace del arreglo existente, configura el parámetro syncSource. Remover un espacio de nombres excluido requiere una resincronización completa. Sin el parámetro syncSource, la solicitud falla. Si tu nueva lista solo añade al arreglo existente, no configures syncSource.
includedNamespaces	Arreglo de cadenas	Condicional	Cloud Manager acepta este parámetro para tareas de copia de seguridad que ejecutan MongoDB `FCV` 4.0 o anterior. Cloud Manager ignora este parámetro cuando respalda bases de datos de MongoDB que ejecutan compatibilidad de características entre versiones 4.2 o posterior. Lista de nombres de bases de datos y colecciones a incluir en la copia de seguridad. Cada string representa un namespace. Los espacios de nombres utilizan el formato de {database} o {database}.{collection}. Este parámetro debe cumplir con las siguientes condiciones: Cloud Manager acepta este parámetro o excludedNamespaces, pero no ambos. Cloud Manager requiere la nueva lista completa de namespaces incluidos, incluso los que ya se encuentren en el arreglo. Si la nueva lista agrega algún espacio de nombres del arreglo existente, configure el parámetro syncSource. Añadir un namespace incluido requiere una resynchronización completa. Sin el parámetro syncSource, la solicitud falla. Si la nueva lista solo elimina espacios de nombres del arreglo existente, no establezcas syncSource.
Contraseña	string	Condicional	Contraseña que se usará para conectar con la base de datos fuente de sincronización. Cloud Manager requiere este parámetro cuando las instancias de `mongod` del almacén de sincronización exigen que los clientes se autentiquen.
preferedMember	string	Opcional	Nodo del clúster que un usuario designa como el nodo preferente del set de réplicas para crear snapshots. Puedes establecer el nodo preferido usando el consola. Visualice los miembros disponibles del conjunto de réplicas que pueden actuar como nodos preferentes utilizando el Obtener un endpoint de configuración de copia de seguridad.
provisionamineto	booleano	Condicional	Indicador que muestra si Cloud Manager ha aprovisionado los recursos necesarios para almacenar una copia de seguridad.
sslEnabled	booleano	Opcional	Indicador que señala si TLS está habilitado para la base de datos origen de sincronización.
Nombre del estado	string	Opcional	Estado actual (o deseado) de la configuración de la copia de seguridad. Cloud Manager acepta: Inactivo Provisionamineto INICIADO DETENIDO FINALIZANDO
storageEngineName	string	Opcional	Motor de almacenamiento utilizado para la copia de seguridad. Cloud Manager acepta: MEMORY_MAPPED WIRED_TIGER
syncSource	string	Condicional	instancia `mongod` para obtener los datos de la copia de seguridad. Cloud Manager acepta un nombre de host específico o uno de los siguientes: primario y secundario. Cloud Manager requiere este parámetro si "storageEngineName": "WIRED_TIGER".
Nombre de usuario	string	Condicional	Nombre del usuario que se utilizará para conectarse a la base de datos de origen de sincronización. Cloud Manager requiere este parámetro cuando las instancias de `mongod` del almacén de sincronización exigen que los clientes se autentiquen. Envía este parámetro a Cloud Manager cuando actualices la configuración de la copia de seguridad para un set de réplicas o clúster fragmentado que Cloud Manager no gestione.

Respuesta

Nombre	Tipo	Descripción
authMechanismName	string	Nombre del mecanismo de autenticación que se utilizará al conectar con la base de datos fuente de sincronización. Cloud Manager devuelve este parámetro si el almacén de sincronización utiliza autenticación.
clusterId	string	Identificador único del clúster al que se aplica esta configuración de copia de seguridad.
espacios de nombres excluidos	Arreglo de cadenas	Lista de nombres de bases de datos y nombres de colecciones para omitir en la copia de seguridad. Cada string es un namespace en la forma de {base de datos} o {base de datos}.{collection}.
includedNamespaces	Arreglo de cadenas	Lista de nombres de bases de datos y nombres de colecciones a incluir en la copia de seguridad. Cada string es un namespace en la forma de {base de datos} o {base de datos}.{colección}.
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.
preferedMember	string	Nodo de clúster que un usuario designa como el nodo preferido del set de réplicas para crear snapshots. Puedes configurar el nodo preferido utilizando la consola. Ver nodos disponibles del set de réplicas que pueden actuar como nodo preferido utilizando la Obtener un punto de configuración de copia de seguridad.
ID del proyecto	string	Identificador único del Proyecto que posee esta configuración de copia de seguridad.
provisionamineto	booleano	Bandera que indica si Cloud Manager ha aprovisionado los recursos necesarios para almacenar una copia de seguridad. Cloud Manager devuelve este parámetro cuando la cantidad de datos que se van a respaldar supera un cierto umbral.
sslEnabled	booleano	Indicador que señala si TLS está habilitado para la base de datos origen de sincronización.
Nombre del estado	string	Estado actual (o deseado) de la configuración de copias de seguridad.
storageEngineName	string	El motor de almacenamiento se utiliza para la copia de seguridad.

Solicitud de ejemplo

1 curl --user "{publicKey}:{privateKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"
5      --data '
6        {
7          "statusName": "STARTED",
8          "storageEngineName": "WIRED_TIGER",
9          "syncSource": "primary"
10        }'

Cuando se inicia cada snapshot, Cloud Manager selecciona un miembro del set de réplicas para ejecutar el snapshot. Este nodo seleccionado automáticamente debe tener el menor impacto en el rendimiento del set de réplicas. Puede anular la selección por defecto.

Importante

Usar default selection cuando sea posible. Esta elección asegura la disponibilidad de la copia de seguridad.

La siguiente solicitud establece el nodo preferido.

1 curl --user "{publicKey}:{privateKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"
5      --data '
6        {
7          "preferredMember":"<HOSTNAME>:<PORT>"
8        }'

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

1 {
2   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9   "rel" : "self"
10   }, {
11     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/   {projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18     "rel" : "http://mms.mongodb.com/snapshotSchedule"
19   } ],
20   "sslEnabled" : false,
21   "statusName" : "STARTED",
22   "storageEngineName" : "WIRED_TIGER"
23 }

Importante

Utiliza default selection siempre que sea posible. Esta opción garantiza la disponibilidad de copias de seguridad.

La siguiente respuesta incluye el nodo preferido.

1 {
2   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9   "rel" : "self"
10   }, {
11     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://cloud.mongodb.com/api/public/v1.0/groups/   {projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18     "rel" : "http://mms.mongodb.com/snapshotSchedule"
19   } ],
20   "sslEnabled" : false,
21   "statusName" : "STARTED",
22   "storageEngineName" : "WIRED_TIGER",
23   "preferredMember":"{HOSTNAME}:{PORT}"
24 }

Volver

Obtenga uno

Cronograma de instantáneas

1	curl --user "{publicKey}:{privateKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}"
5	--data '
6	{
7	"statusName": "STARTED",
8	"storageEngineName": "WIRED_TIGER",
9	"syncSource": "primary"
10	}'

1	{
2	"authMechanismName" : "NONE",
3	"clusterId" : "{clusterId}",
4	"encryptionEnabled" : false,
5	"excludedNamespaces" : [ ],
6	"groupId" : "{projectId}",
7	"links" : [ {
8	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9	"rel" : "self"
10	}, {
11	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12	"rel" : "http://mms.mongodb.com/cluster"
13	}, {
14	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/{projectId}",
15	"rel" : "http://mms.mongodb.com/group"
16	}, {
17	"href" : "http://cloud.mongodb.com/api/public/v1.0/groups/ {projectId}/backupConfigs/{clusterId}/snapshotSchedule",
18	"rel" : "http://mms.mongodb.com/snapshotSchedule"
19	} ],
20	"sslEnabled" : false,
21	"statusName" : "STARTED",
22	"storageEngineName" : "WIRED_TIGER"
23	}