/ /

Copia de seguridad y restauración

Regiones de implementación

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Copia de seguridad y restauración

Regiones de implementación

Obtén una región de implementación

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 /admin/backup/backupDeployments/{DEPLOYMENT-ID}

Request Parameters

Parámetros de ruta de solicitud

Parameter	Tipo	Necesidad	Descripción
implementación-ID	string	Requerido	Identificador único que referencia la región de implementación en las configuraciones.

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 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 `results` es un sobre. Ops Manager agrega 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
`assignmentEnabled`	booleano	Indicador que señala si puede asignar Regiones de implementación para recursos de copia de seguridad.
`bqProxyEndpoint`	string	Instancia de Ops Manager que presta servicios a las solicitudes de respaldo consultable. El valor está en el siguiente formato: `domain:port`. Por ejemplo, `localhost:8080`.
`deploymentDescription`	string	String que describe el propósito de la región de implementación.
`id`	string	Identificador único que referencia esta región de implementación en las configuraciones.
`ingestionEndpoint`	string	Instancia de Ops Manager a la que el agente de copias de seguridad escribe datos de instantánea u oplog. El valor es una URL válida, como `http://www.mongodb.com`. Admite tanto HTTP como HTTPS.
`links`	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.
`restoreEndpoint`	string	Instancia de Ops Manager que atiende las solicitudes de restauración.

Solicitud de ejemplo

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?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    "assignmentEnabled" : true,
3    "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
4    "deploymentDescription" : "Eastern US",
5    "id" : "NY_NJ",
6    "ingestionEndpoint" : "https://api-backup.mongodb.com",
7    "links" : [ ],
8    "restoreEndpoint" : "https://api-backup.mongodb.com"
9 }

Volver

Obtener todo

Crear

1	{
2	"assignmentEnabled" : true,
3	"bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
4	"deploymentDescription" : "Eastern US",
5	"id" : "NY_NJ",
6	"ingestionEndpoint" : "https://api-backup.mongodb.com",
7	"links" : [ ],
8	"restoreEndpoint" : "https://api-backup.mongodb.com"
9	}