/ /

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 por ID

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 tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PUT /admin/backup/backupDeployments/{DEPLOYMENT-ID}

Request Parameters

Parámetros de la ruta de solicitud

Path Parameter	Tipo	Necesidad	Descripción
{ID DE IMPLEMENTACIÓN}	string	Requerido	Identificador único que hace referencia a esta región de implementación en las configuraciones.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
`assignmentEnabled`	booleano	Opcional	Bandera que indica si se puede asignar Regiones de implementación para realizar copias de seguridad de los recursos.
Punto final del proxy bq	string	Requerido	Instancia de Ops Manager que atiende solicitudes de copia de seguridad consultables. El valor tiene el siguiente`domain:port` formato:. Por ejemplo,. `localhost:8080`
Descripción de la implementación	string	Requerido	Cadena que describe el propósito de la región de implementación.
punto final de ingestión	string	Requerido	Instancia de Ops Manager donde el agente de backup escribe datos de instantáneas o registros de operaciones. El valor es una URL válida,`http://www.mongodb.com` como. Compatible con HTTP y HTTPS.
restaurarPunto final	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 atiende solicitudes de copia de seguridad consultables. El valor tiene el siguiente`domain:port` formato:. Por ejemplo,. `localhost:8080`
`deploymentDescription`	string	Cadena que describe el propósito de la región de implementación.
`id`	string	Identificador único que hace referencia a esta región de implementación en las configuraciones.
`ingestionEndpoint`	string	Instancia de Ops Manager donde el agente de backup escribe datos de instantáneas o registros de operaciones. El valor es una URL válida,`http://www.mongodb.com` como. Compatible con HTTP y HTTPS.
`links`	matriz de objetos	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.

Ejemplo de solicitud

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PUT
     "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/AU_NJ?pretty=true" \
     --data '
       {
         "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
       }'

Ejemplo de respuesta

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}

Cuerpo de respuesta

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

Volver

Crear

Asignar