/ /

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

Crear una Región de implementación

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

POST /admin/backup/backupDeployments

Request Parameters

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

Nombre	Tipo	Necesidad	Descripción
`assignmentEnabled`	booleano	Opcional	Indicador que señala si puede asignar Regiones de implementación para recursos de copia de seguridad.
`bqProxyEndpoint`	string	Requerido	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	Requerido	String que describe el propósito de la región de implementación.
`id`	string	Requerido	Identificador único que referencia esta región de implementación en las configuraciones.
`ingestionEndpoint`	string	Requerido	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.
`restoreEndpoint`	string	Requerido	Instancia de Ops Manager que atiende solicitudes de restauración.

Respuesta

Nombre	Tipo	Descripción
`assignmentEnabled`	booleano	Bandera que indica si se pueden asignar regiones de implementación a los recursos de respaldo.
`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 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.
`restoreEndpoint`	string	Instancia de Ops Manager que atiende solicitudes de restauración.

Solicitud de ejemplo

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?pretty=true"
     --data '
       {
         "id": "AU_NZ",
         "ingestionEndpoint": "https://api-backup.mongodb.com",
         "restoreEndpoint": "https://api-backup.mongodb.com",
         "bqProxyEndpoint": "queryable-backup.mongodb.com:27217",
         "deploymentDescription": "Australia and New Zealand",
         "assignmentEnabled": 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

{
  "assignmentEnabled" : true,
  "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
  "deploymentDescription" : "Australia and New Zealand",
  "id" : "AU_NZ",
  "ingestionEndpoint" : "https://api-backup.mongodb.com",
  "links" : [ ],
  "restoreEndpoint" : "https://api-backup.mongodb.com"
}

Volver

Obtenga uno

Crear por ID