/ /

Copia de seguridad y restauración

Configuraciones de respaldo

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Copia de seguridad y restauración

Configuraciones de respaldo

Actualizar una configuración de copia de seguridad

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

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

Resource

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

Request Parameters

Parámetros de la ruta de solicitud

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

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 un impresión bonita 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	Necesidad	Descripción
nombreDeMecanismoDeAutorización	string	Condicional	Mecanismo de autenticación necesario para conectarse a la base de datos de origen de sincronización. Ops Manager requiere este parámetro si el almacén de sincronización utiliza autenticación. Ops Manager acepta: `MONGODB_CR` (Esto cubre SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-CR). `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
encryptionEnabled	booleano	Opcional	Bandera que indica si el cifrado está habilitado para la configuración de copia de seguridad. Debes incluir el parámetro syncSource al habilitar el cifrado para una configuración de copia de seguridad. Para las copias de seguridad existentes en un proyecto, habilitar el cifrado requiere una sincronización inicial para recrear las bases de datos principales de las copias de seguridad. FCV `4.2` y posteriormente usar cursores de respaldo en lugar de bases de datos principales. Para más información, consulte Servicio Daemon de respaldo. Para obtener más información sobre el cifrado de respaldo para FCV 4.2 o posterior, consulte Instantáneas de respaldo cifradas.
espacios de nombres excluidos	matriz de cadenas	Condicional	Lista de nombres de bases de datos y colecciones que se omitirán en la copia de seguridad. Cada cadena representa un espacio de nombres. Los espacios de nombres utilizan uno de los siguientes formatos: {base de datos} {base de datos}.{colección}. Ops Manager acepta este parámetro para trabajos de copia de seguridad que ejecutan MongoDB FCV 4.0 o una versión anterior. Ops Manager ignora este parámetro al realizar copias de seguridad de bases de datos MongoDB que ejecutan FCV 4.2 o una versión posterior. Este parámetro debe cumplir las siguientes condiciones: Ops Manager acepta este parámetro o includedNamespaces, no ambos. Ops Manager requiere la nueva lista completa de espacios de nombres excluidos, incluidos todos los que ya se encuentran en la matriz. Si tu nueva lista remueve algún namespace del arreglo existente, configura el parámetro syncSource. Para eliminar un espacio de nombres excluido es necesario realizar una resincronización completa. Sin el parámetro syncSource, la solicitud falla. Si su nueva lista solo se agrega a la matriz existente, no configure syncSource.
espacios de nombres incluidos	matriz de cadenas	Condicional	Lista de nombres de bases de datos y colecciones que se incluirán en la copia de seguridad. Cada cadena representa un espacio de nombres. Los espacios de nombres utilizan uno de los siguientes formatos: {base de datos} {base de datos}.{colección}. Ops Manager acepta este parámetro para trabajos de copia de seguridad que ejecutan MongoDB FCV 4.0 o una versión anterior. Ops Manager ignora este parámetro al realizar copias de seguridad de bases de datos MongoDB que ejecutan FCV 4.2 o una versión posterior. Este parámetro debe cumplir las siguientes condiciones: Ops Manager acepta este parámetro o los espacios de nombres excluidos, no ambos. Ops Manager requiere la nueva lista completa de espacios de nombres incluidos, incluidos todos los que ya se encuentran en la matriz. Si la nueva lista agrega espacios de nombres de una matriz existente, configure el parámetro syncSource. Agregar un espacio de nombres incluido requiere una resincronización completa. Sin el parámetro syncSource, la solicitud falla. Si la nueva lista solo elimina espacios de nombres de la matriz existente, no configure syncSource.
contraseña	string	Condicional	Contraseña para conectarse a la base de datos de origen de sincronización. Ops Manager requiere este parámetro cuando las instancias del almacén de sincronización `mongod` requieren la autenticación de los clientes.
Miembro preferido	string	Opcional	Miembro del clúster que un usuario designa como miembro preferido del conjunto de réplicas para crear instantáneas. Puede configurar el miembro preferido mediante la consola. Consulte los miembros del conjunto de réplicas disponibles que pueden actuar como miembro preferido mediante el punto de conexión Obtener una configuración de copia de seguridad.
provisionados	booleano	Condicional	Bandera que indica si Ops Manager ha aprovisionado los recursos necesarios para almacenar una copia de seguridad.
SSL habilitado	booleano	Opcional	Bandera que indica si TLS está habilitado para la base de datos de origen de sincronización.
nombreDeEstado	string	Opcional	Estado actual (o deseado) de la configuración de la copia de seguridad. Ops Manager acepta: INACTIVO APROVISIONAMIENTO INICIADO DETENIDO TERMINANDO
nombreDeMotorDeAlmacenamiento	string	Opcional	Motor de almacenamiento utilizado para la copia de seguridad. Ops Manager acepta: MEMORIA_MAPEADA WIRED_TIGER
syncSource	string	Condicional	`mongod` Instancia desde la que se recuperan los datos de respaldo. Ops Manager acepta un nombre de host específico o uno de los siguientes: PRIMARIO y SECUNDARIO. Ops Manager requiere este parámetro si "storageEngineName": "WIRED_TIGER".
Nombre de usuario	string	Condicional	Nombre del usuario que se usará para conectarse a la base de datos de origen de sincronización. Ops Manager requiere este parámetro cuando las instancias del almacén de sincronización `mongod` requieren la autenticación de los clientes. Envíe este parámetro a Ops Manager al actualizar la configuración de respaldo para un conjunto de réplicas o un clúster fragmentado que Ops Manager no administra.
snapshotStore	Objeto	Opcional	Objeto que especifica el almacén de instantáneas al que se realizará la transición. Este objeto contiene el tipo de almacén de instantáneas y el ID del3 depósito S (almacén de3 bloques S). Las instantáneas existentes permanecen en el almacén original hasta que caduquen, según la política de retención configurada. También puede realizar la transición entre almacenes3de instantáneas compatibles con S desde la página Trabajos.
snapshotStore.snapshotStoreType	string	condicional	Cadena que identifica el tipo de almacén de instantáneas. Actualmente, solo se admite un depósito S3 (almacén de bloques S3). El valor debe ser `s3blockstore`. Si proporciona el objeto `snapshotStore`, debe especificar los parámetros `snapshotStoreType` y `snapshotStoreId`.
snapshotStore.snapshotStoreId	string	condicional	Cadena que identifica el almacén de bloques S3 al que se realizará la transición. Las nuevas instantáneas se almacenarán en este almacén de bloques S3 de destino. Las instantáneas existentes permanecen en el almacén original hasta que caduquen, según la política de retención configurada. Si proporciona el objeto `snapshotStore`, debe especificar los parámetros `snapshotStoreType` y `snapshotStoreId`.

Respuesta

Nombre	Tipo	Descripción
nombreDeMecanismoDeAutorización	string	Nombre del mecanismo de autenticación que se usará al conectarse a la base de datos de origen de sincronización. Ops 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.
encryptionEnabled	booleano	Indicador que indica si el cifrado está habilitado para la configuración de copia de seguridad. Debe incluir el campo syncSource al habilitar el cifrado para una configuración de copia de seguridad. En el caso de las copias de seguridad existentes en un proyecto, habilitar el cifrado requiere una sincronización inicial para recrear las bases de datos principales de las copias de seguridad. FCV `4.2` y posteriormente usar cursores de respaldo en lugar de bases de datos principales. Para más información, consulte el Servicio Daemon de Respaldo. Para obtener más información sobre el cifrado de respaldo para FCV 4.2 o posterior, consulte Instantáneas de respaldo cifradas.
espacios de nombres excluidos	matriz de cadenas	Lista de nombres de bases de datos y colecciones que se omitirán en la copia de seguridad. Cada cadena es un espacio de nombres con el formato {database} o {database}.{collection}.
espacios de nombres incluidos	matriz de cadenas	Lista de nombres de bases de datos y colecciones que se incluirán en la copia de seguridad. Cada cadena es un espacio de nombres con el formato {database} o {database}.{collection}.
Miembro preferido	string	Miembro del clúster que un usuario designa como miembro preferido del conjunto de réplicas para crear instantáneas. Puede configurar el miembro preferido mediante la consola. Consulte los miembros del conjunto de réplicas disponibles que pueden actuar como miembro preferido mediante el punto de conexión Obtener una configuración de copia de seguridad.
ID del proyecto	string	Identificador único del proyecto que posee esta configuración de respaldo.
provisionados	booleano	Indicador que indica si Ops Manager ha proporcionado los recursos necesarios para almacenar una copia de seguridad. Ops Manager devuelve este parámetro cuando la cantidad de datos a respaldar supera un umbral determinado.
SSL habilitado	booleano	Bandera que indica si TLS está habilitado para la base de datos de origen de sincronización.
nombreDeEstado	string	Estado actual de la configuración de la copia de seguridad.
nombreDeMotorDeAlmacenamiento	string	Motor de almacenamiento utilizado para la copia de seguridad.
snapshotStore	Objeto	Objeto que especifica el almacén de instantáneas al que se realizará la transición. Este objeto contiene el tipo de almacén de instantáneas y el ID del3 depósito S (almacén de3 bloques S). Las instantáneas existentes permanecen en el almacén original hasta que caduquen, según la política de retención configurada. También puede realizar la transición entre almacenes3de instantáneas compatibles con S desde la página Trabajos.
snapshotStore.snapshotStoreType	string	Cadena que identifica el tipo de almacén de instantáneas. Actualmente, solo se admite un depósito S3 (almacén de bloques S3). El valor debe ser `s3blockstore`. Si especifica el objeto `snapshotStore`, debe especificar los parámetros `snapshotStoreType` y `snapshotStoreId`.
snapshotStore.snapshotStoreId	string	Cadena que identifica el almacén de bloques S3 al que se realizará la transición. Las nuevas instantáneas se almacenarán en este almacén de bloques S3 de destino. Las instantáneas existentes permanecen en el almacén original hasta que caduquen, según la política de retención configurada. Si proporciona el objeto `snapshotStore`, debe especificar los parámetros `snapshotStoreType` y `snapshotStoreId`.

Ejemplo de solicitud

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

Al iniciar cada instantánea, Ops Manager selecciona un miembro del conjunto de réplicas para ejecutarla. Este miembro seleccionado automáticamente debería tener el menor impacto posible en el rendimiento del conjunto de réplicas. Puede anular la selección predeterminada.

Importante

Usar default selection siempre que sea posible. Esta opción garantiza 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://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \
5      --data '
6        {
7          "preferredMember":"{HOSTNAME}:{PORT}"
8        }'

1 curl --user "{publicKey}:{privateKey}" \
2      --digest \
3      --header "Accept: application/json" \
4      --header "Content-Type: application/json" \
5      --include --request PATCH "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \
6      --data '
7        {
8          "snapshotStore": {"snapshotStoreId":"{snapshotStoreId}", "snapshotStoreType":"s3blockstore"}
9        }'

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

1 {
2   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9     "rel" : "self"
10    }, {
11     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://<OpsManagerHost>:<Port>/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

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

La siguiente respuesta incluye miembro preferido.

1 {
2   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9     "rel" : "self"
10    }, {
11     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://<OpsManagerHost>:<Port>/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 }

1 {
2   "authMechanismName" : "NONE",
3   "clusterId" : "{clusterId}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6   "groupId" : "{projectId}",
7   "links" : [ {
8     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9     "rel" : "self"
10    }, {
11     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12     "rel" : "http://mms.mongodb.com/cluster"
13   }, {
14     "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",
15     "rel" : "http://mms.mongodb.com/group"
16   }, {
17     "href" : "http://<OpsManagerHost>:<Port>/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   "snapshotStore": {
24     "snapshotStoreType": "s3blockstore",
25     "snapshotStoreId": "your-snapshot-store-id"
26   }
27 }

Volver

Consigue uno

Regiones de implementación

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

1	curl --user "{publicKey}:{privateKey}" \
2	--digest \
3	--header "Accept: application/json" \
4	--header "Content-Type: application/json" \
5	--include --request PATCH "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \
6	--data '
7	{
8	"snapshotStore": {"snapshotStoreId":"{snapshotStoreId}", "snapshotStoreType":"s3blockstore"}
9	}'

1	{
2	"authMechanismName" : "NONE",
3	"clusterId" : "{clusterId}",
4	"encryptionEnabled" : false,
5	"excludedNamespaces" : [ ],
6	"groupId" : "{projectId}",
7	"links" : [ {
8	"href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",
9	"rel" : "self"
10	}, {
11	"href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",
12	"rel" : "http://mms.mongodb.com/cluster"
13	}, {
14	"href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",
15	"rel" : "http://mms.mongodb.com/group"
16	}, {
17	"href" : "http://<OpsManagerHost>:<Port>/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	}