/ /

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

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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/backupConfigs

Request Parameters

Parámetros de la ruta de solicitud

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

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	Bandera que indica si el cuerpo de la respuesta debe estar en una 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 una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

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.
nombreDeEstado	string	Estado actual (o deseado) de la configuración de la copia de seguridad. Los valores posibles son: `INACTIVE` `PROVISIONING` `STARTED` `STOPPED` `TERMINATING`
nombreDeMotorDeAlmacenamiento	string	Motor de almacenamiento utilizado para la copia de seguridad. Los valores posibles son: `MEMORY_MAPPED` `WIRED_TIGER`

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.

SSL habilitado	booleano	Bandera que indica si TLS está habilitado para la base de datos de origen 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`.
espacios de nombres incluidos	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://{opsManagerHost}:{port}/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 respaldo

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	}