/ /

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

Obtener una configuración de copia de seguridad de un proyecto

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 grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene como se indica en el documento.

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

Resource

GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}

Request Parameters

Parámetros de la ruta de solicitud

Parameter	Tipo	Necesidad	Descripción
PROJECT-ID	string	Requerido	string única de 24 dígitos hexadecimales que identifica el Proyecto que contiene el clúster con la configuración de copia de seguridad que deseas encontrar.
CLUSTER-ID	string	Requerido	string única de 24 dígitos hexadecimales que identifica el clúster cuya configuración de copia de seguridad deseas encontrar.

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

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`availableMembers`	arreglo de string	Lista de miembros del clúster disponibles para copia de seguridad. Aparece solo para solicitudes de nodos.
`clusterId`	string	Unique 24-hexadecimal digit string that identifies the clúster to configure for la copia de seguridad.
`encryptionEnabled`	booleano	Indicador que indica si el cifrado está habilitado para la configuración de copia de seguridad. Debe incluir el `syncSource` campo 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. compatibilidad de características entre versiones `4.2` y posteriormente usar cursores de respaldo en lugar de bases de datos principales. Para más información, consulte Servicio del daemon de copias de seguridad. Para obtener más información sobre el cifrado de respaldo para FCV 4.2 o posterior, consulte Instantáneas de respaldo cifradas.
`excludedNamespaces`	arreglo de string	Lista de nombres de bases de datos y nombres de colecciones para omitir en la copia de seguridad. Cada string es un espacio de nombres con la forma de `{database}` o `{database}.{collection}`. Si este campo está presente, el campo `includedNamespaces` no puede estar presente. Debe enviar la nueva lista completa de espacios de nombres excluidos, incluidos los que ya estaban listados. Si la nueva lista remueve algún espacio de nombres de la lista anterior, también debes configurar el campo `syncSource`, ya que la remoción de un espacio de nombres excluido requiere una resync completa. Sin el campo `syncSource`, la solicitud fallará. Si la nueva lista solo añade a la lista anterior, no necesitas establecer `syncSource`.
`groupId`	string	string Única de 24 dígitos hexadecimales que identifica el Proyecto que posee esta configuración de copia de seguridad.
`includedNamespaces`	arreglo de string	Lista de nombres de bases de datos y nombres de colecciones para incluir en la copia de seguridad. Cada string es un espacio de nombres con la forma de `{database}` o `{database}.{collection}`. Cualquier namespace que no esté listado en este arreglo no será respaldado. Si este campo está presente, el campo `excludedNamespaces` no puede estar presente. Debes enviar la nueva lista completa de namespaces incluidos, incluso aquellos que ya estaban listados. Si la nueva lista agrega cualquier espacio de nombres a la lista anterior, también debes configurar el campo `syncSource`, ya que la adición de un espacio de nombres incluido requiere una resincronización completa. Sin el campo `syncSource`, la solicitud fallará. Si la nueva lista solo remueve namespace de la lista anterior, no necesitas configurar `syncSource`.
`links`	objeto arreglo	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.
`multiRegionBackupEnabled`	booleano	Indicador que muestra si la copia de seguridad multiregión está habilitada para el clúster.
`multiRegionMisconfigured`	booleano	Marca que indica si la copia de seguridad multirregional, si está habilitada, está en `Misconfigured` estado. El valor puede ser uno de los siguientes: `true` - el estado es `Misconfigured` y Ops Manager no tomará nuevas snapshots, aunque Ops Manager continúa oplog tailing sin interrupciones para los miembros del clúster con regiones asignadas. Debe seleccionar una región de implementación para los nuevos miembros del clúster, a fin de que Ops Manager pueda retomar la creación de nuevos snapshots para todos los miembros del clúster. `false` - el estado es `Active`.
`preferredMember`	string	Nodo del clúster designado manualmente como el nodo preferido para la copia de seguridad. Aparece solo para solicitudes de nodos cuando el nodo preferido se establece mediante la Interfaz de Usuario o la API.
`sslEnabled`	booleano	Bandera que identifica si TLS está activado para la base de datos fuente de sincronizar.
`statusName`	string	Estado actual (o deseado) de la configuración de la copia de seguridad. Los valores posibles son: `INACTIVE` `PROVISIONING` `STARTED` `STOPPED` `TERMINATING`
`storageEngineName`	string	Motor de almacenamiento utilizado para la copia de seguridad. Los valores posibles son: `MEMORY_MAPPED` `WIRED_TIGER`

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"

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 cuando sea posible. Esta elección asegura la disponibilidad de la copia de seguridad.

La siguiente solicitud devuelve los miembros disponibles.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"

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   "clusterId" : "{CLUSTER-ID}",
3   "encryptionEnabled" : false,
4   "excludedNamespaces" : [ ],
5   "groupId" : "{PROJECT-ID}",
6   "includedNamespaces" : [ ],
7   "links" : [ ],
8   "multiRegionBackupEnabled" : false,
9   "multiRegionMisconfigured" : false,
10   "sslEnabled" : false,
11   "statusName" : "STARTED",
12   "storageEngineName" : "WIRED_TIGER"
13 }

Importante

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

La siguiente respuesta incluye los miembros disponibles y el miembro preferente designado. Si un miembro preferente no está definido, se excluye de la respuesta.

1 {
2   "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"],
3   "clusterId" : "{CLUSTER-ID}",
4   "encryptionEnabled" : false,
5   "excludedNamespaces" : [ ],
6    "groupId" : "{PROJECT-ID}",
7    "includedNamespaces" : [ ],
8    "links" : [ ],
9    "multiRegionBackupEnabled" : true,
10    "multiRegionMisconfigured" : false,
11    "sslEnabled" : false,
12    "statusName" : "STARTED",
13    "storageEngineName" : "WIRED_TIGER",
14    "preferredMember" : "{HOSTNAME1}:{PORT1}"
15  }

Volver

Obtener todo

Update

1	{
2	"clusterId" : "{CLUSTER-ID}",
3	"encryptionEnabled" : false,
4	"excludedNamespaces" : [ ],
5	"groupId" : "{PROJECT-ID}",
6	"includedNamespaces" : [ ],
7	"links" : [ ],
8	"multiRegionBackupEnabled" : false,
9	"multiRegionMisconfigured" : false,
10	"sslEnabled" : false,
11	"statusName" : "STARTED",
12	"storageEngineName" : "WIRED_TIGER"
13	}

1	{
2	"availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"],
3	"clusterId" : "{CLUSTER-ID}",
4	"encryptionEnabled" : false,
5	"excludedNamespaces" : [ ],
6	"groupId" : "{PROJECT-ID}",
7	"includedNamespaces" : [ ],
8	"links" : [ ],
9	"multiRegionBackupEnabled" : true,
10	"multiRegionMisconfigured" : false,
11	"sslEnabled" : false,
12	"statusName" : "STARTED",
13	"storageEngineName" : "WIRED_TIGER",
14	"preferredMember" : "{HOSTNAME1}:{PORT1}"
15	}