/ /

Copia de seguridad y restauración

Configuraciones de copia de seguridad

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Copia de seguridad y restauración

Configuraciones de copia de seguridad

Actualizar Una Configuración de copia de seguridad

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece 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 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 la respuesta debe estar en un pretty-print 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. Ops Manager necesita 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. compatibilidad de características entre versiones `4.2` y más adelante utilizar cursors de respaldo en lugar de bases de datos principales. Para obtener más información, ver Servicio del daemon de copias de seguridad. Para obtener más información sobre el cifrado de copias de seguridad para FCV 4.2 o posterior, consulta Instantáneas cifradas de copias de seguridad.
espacios de nombres excluidos	Arreglo de cadenas	Condicional	Lista de nombres de bases de datos y colecciones para omitir en la copia de seguridad. Cada string representa un namespace. 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 compatibilidad de características entre versiones 4.0 o anterior. Ops Manager ignora este parámetro al realizar copias de seguridad de bases de datos MongoDB que ejecutan la compatibilidad de características entre versiones 4.2 o posterior. Este parámetro debe cumplir con las siguientes condiciones: Ops Manager acepta este parámetro o includedNamespaces, pero no ambos. Ops Manager requiere la nueva lista completa de namespaces excluidos, incluyendo cualquier namespace que ya se encuentre 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	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 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 compatibilidad de características entre versiones 4.0 o anterior. Ops Manager ignora este parámetro al realizar copias de seguridad de bases de datos MongoDB que ejecutan la compatibilidad de características entre versiones 4.2 o posterior. Este parámetro debe cumplir con las siguientes condiciones: Ops Manager acepta este parámetro o excludedNamespaces, pero no ambos. El Gestor de Operaciones requiere la nueva lista completa de namespaces incluidos, incluyendo cualquier namespace que ya se encuentre 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. Ops Manager requiere este parámetro cuando las instancias del almacén de sincronización `mongod` requieran que los clientes se autentiquen.
preferedMember	string	Opcional	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.
provisionamineto	booleano	Condicional	Flag that indicates if Ops Manager has provisioned the recursos needed to almacenar a 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. Ops Manager acepta: Inactivo Provisionamineto INICIADO DETENIDO FINALIZANDO
storageEngineName	string	Opcional	Motor de almacenamiento utilizado para la copia de seguridad. Ops Manager acepta: MEMORY_MAPPED WIRED_TIGER
syncSource	string	Condicional	`mongod` instancia desde la cual se recuperan los datos de la copia de seguridad. Ops Manager acepta un nombre de host específico o uno de los siguientes: PRIMARY y SECONDARY. Ops Manager requiere este parámetro si "storageEngineName" : "WIRED_TIGER".
Nombre de usuario	string	Condicional	Nombre del usuario que se utilizará para conectar 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 que los clientes se autentiquen. Envía este parámetro a Ops Manager cuando actualices la configuración de la copia de seguridad para un set de réplicas o un clúster fragmentado que Ops Manager no gestiona.
snapshotStore	Objeto	Opcional	Objeto que especifica el almacenamiento de snapshot al que se debe cambiar. Este objeto contiene el tipo de almacenamiento de snapshot y el ID del bucket de S3 (almacenamiento en bloques de S3). Las instantáneas existentes permanecen en el almacén original hasta que expiren según su política de retención configurada. También puedes pasar entre almacenamientos de snapshot compatibles con S3desde la página Trabajos.
snapshotStore.snapshotStoreType	string	Condicional	String que identifica el tipo de almacenamiento de snapshot. Actualmente, solo se admite un bucket S3 (almacenamiento en bloques S3). El valor debe ser `s3blockstore`. Si se proporciona el objeto `snapshotStore`, se deben especificar tanto los parámetros `snapshotStoreType` y `snapshotStoreId`.
snapshotStore.snapshotStoreId	string	Condicional	String que identifica el S3 almacenamiento en bloques al que se debe hacer la transición. Las nuevas instantáneas se almacenarán en este S3 almacenamiento en bloques de destino. Las instantáneas existentes permanecen en el almacén original hasta que expiren según su política de retención configurada. Si proporcionas el objeto `snapshotStore` debes especificar tanto los parámetros `snapshotStoreType` como `snapshotStoreId`.

Respuesta

Nombre	Tipo	Descripción
authMechanismName	string	Nombre del mecanismo de autenticación a utilizar al conectar con 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	Bandera que indica si el cifrado está habilitado para la configuración de copia de seguridad. Debes incluir el campo 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. compatibilidad de características entre versiones `4.2` y luego use cursores de copia de seguridad en lugar de bases de datos principales. Para obtener más información, consulte Servicio Daemon de copia de seguridad. Para obtener más información sobre el cifrado de copias de seguridad para FCV 4.2 o posterior, consulta Instantáneas cifradas de copias 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}.
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	Indicador que señala si el administrador de operaciones (Ops Manager) ha aprovisionado los recursos necesarios para almacenar una copia de seguridad. Ops Manager devuelve este parámetro cuando la cantidad de datos a respaldar supera un determinado 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 de la configuración de copia de seguridad.
storageEngineName	string	El motor de almacenamiento se utiliza para la copia de seguridad.
snapshotStore	Objeto	Objeto que especifica el almacenamiento de snapshot al que se debe cambiar. Este objeto contiene el tipo de almacenamiento de snapshot y el ID del bucket de S3 (almacenamiento en bloques de S3). Las instantáneas existentes permanecen en el almacén original hasta que expiren según su política de retención configurada. También puedes pasar entre almacenamientos de snapshot compatibles con S3desde la página Trabajos.
snapshotStore.snapshotStoreType	string	String que identifica el tipo de almacenamiento de snapshot. Actualmente, solo se admite un bucket S3 (almacenamiento en bloques S3). El valor debe ser `s3blockstore`. Si especificas el `snapshotStore` objeto, debes especificar los parámetros `snapshotStoreType` y `snapshotStoreId`.
snapshotStore.snapshotStoreId	string	String que identifica el S3 almacenamiento en bloques al que se debe hacer la transición. Las nuevas instantáneas se almacenarán en este S3 almacenamiento en bloques de destino. Las instantáneas existentes permanecen en el almacén original hasta que expiren según su política de retención configurada. Si proporcionas el objeto `snapshotStore` debes especificar tanto los parámetros `snapshotStoreType` como `snapshotStoreId`.

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://<OpsManagerHost>:<Port>/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, Ops Manager selecciona un miembro del conjunto de réplicas para ejecutar la snapshot. Este nodo seleccionado automáticamente debería tener el menor impacto en el rendimiento del set de réplicas. Se 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://<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        }'

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://<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

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://<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

Obtenga 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	}