/ /

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 todas las configuraciones de copia de seguridad para 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

Request Parameters

Parámetros de ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
PROJECT-ID	string	Requerido	string única de 24 dígitos hexadecimales que identifica el proyecto al que aplica la configuración de copia de seguridad.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que señala si el cuerpo de la 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 remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

Parámetros del cuerpo de la solicitud

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

Respuesta

Nombre	Tipo	Descripción
ID del grupo	string	string Única de 24 dígitos hexadecimales que identifica el Proyecto que posee esta configuración de copia de seguridad.
clusterId	string	string única de 24 dígitos hexadecimales que identifica el clúster cuya configuración de copia de seguridad deseas encontrar.
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`
sslEnabled	booleano	Indicador que señala si TLS está habilitado para la base de datos fuente de sincronización.
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`.
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`.

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"

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   "totalCount" : 3,
3   "results" : [ {
4     "groupId" : "{PROJECT-ID}",
5     "clusterId" : "{CLUSTER-ID1}",
6     "statusName" : "STARTED",
7     "storageEngineName" : "WIRED_TIGER",
8     "sslEnabled" : false,
9     "excludedNamespaces" : [ ],
10     "includedNamespaces" : [ ],
11     "links" : [ ]
12   }, {
13     "groupId" : "{PROJECT-ID}",
14     "clusterId" : "{CLUSTER-ID2}",
15     "statusName" : "STARTED",
16     "storageEngineName" : "MEMORY_MAPPED",
17     "sslEnabled" : false,
18     "excludedNamespaces" : [ ],
19     "includedNamespaces" : [ ],
20     "links" : [ ]
21   }, {
22     "groupId" : "{PROJECT-ID}",
23     "clusterId" : "{CLUSTER-ID3}",
24     "statusName" : "STOPPED",
25     "storageEngineName" : "WIRED_TIGER",
26     "sslEnabled" : false,
27     "excludedNamespaces" : [ ],
28     "includedNamespaces" : [ ],
29     "links" : [ ]
30   } ],
31   "links" : [ ]
32 }

Volver

Configuraciones de copia de seguridad

Obtenga uno

1	{
2	"totalCount" : 3,
3	"results" : [ {
4	"groupId" : "{PROJECT-ID}",
5	"clusterId" : "{CLUSTER-ID1}",
6	"statusName" : "STARTED",
7	"storageEngineName" : "WIRED_TIGER",
8	"sslEnabled" : false,
9	"excludedNamespaces" : [ ],
10	"includedNamespaces" : [ ],
11	"links" : [ ]
12	}, {
13	"groupId" : "{PROJECT-ID}",
14	"clusterId" : "{CLUSTER-ID2}",
15	"statusName" : "STARTED",
16	"storageEngineName" : "MEMORY_MAPPED",
17	"sslEnabled" : false,
18	"excludedNamespaces" : [ ],
19	"includedNamespaces" : [ ],
20	"links" : [ ]
21	}, {
22	"groupId" : "{PROJECT-ID}",
23	"clusterId" : "{CLUSTER-ID3}",
24	"statusName" : "STOPPED",
25	"storageEngineName" : "WIRED_TIGER",
26	"sslEnabled" : false,
27	"excludedNamespaces" : [ ],
28	"includedNamespaces" : [ ],
29	"links" : [ ]
30	} ],
31	"links" : [ ]
32	}