/ /

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

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

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

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

Request Parameters

Parámetros de 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 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

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.
espacios de nombres excluidos	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`.
ID del grupo	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`.
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	El nodo del clúster ha sido designado manualmente como el nodo preferido para la copia de seguridad. Aparece solo para solicitudes de nodos cuando el nodo preferido está configurado con la UI or API.
sslEnabled	booleano	Bandera que identifica si TLS está activado para la base de datos fuente de sincronizar.
Nombre del estado	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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"

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 devuelve los nodos disponibles.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/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   "excludedNamespaces" : [ ],
4   "groupId" : "{PROJECT-ID}",
5   "includedNamespaces" : [ ],
6   "links" : [ ],
7   "sslEnabled" : false,
8   "statusName" : "STARTED",
9   "storageEngineName" : "WIRED_TIGER"
10 }

Importante

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

La siguiente respuesta incluye a los nodos disponibles y al nodo preferido designado. Si un nodo preferido no está definido, se excluye de la respuesta.

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

Volver

Obtener todo

Update

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

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