/ /

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

Asignar una región de implementación a un fragmento

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

PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}

Request Parameters

Parámetros de la ruta de solicitud

Parameter	Tipo	Necesidad	Descripción
PROJECT-ID	string	Requerido	Cadena de dígitos hexadecimales 24única que identifica el proyecto que contiene el clúster con la configuración de respaldo que desea encontrar.
CLUSTER-ID	string	Requerido	string única de 24 dígitos hexadecimales que identifica el clúster cuya configuración de copia de seguridad deseas encontrar.

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
`deploymentConfigs`	matriz de objetos	Requerido	Objetos de especificación para los miembros del clúster para los cuales se asignarán regiones de implementación.
`deploymentConfigs` `.rsId`	string	Requerido	Etiqueta del conjunto de réplicas que identifica el fragmento.
`deploymentConfigs` `.deploymentId`	string	Requerido	Identificador único que hace referencia a la región de implementación que se asignará al fragmento.
`multiRegionBackupEnabled`	booleano	Requerido	Bandera que indica si La copia de seguridad multirregional está habilitada para el clúster.

Respuesta

Nombre	Tipo	Descripción
`authMechanismName`	string	Mecanismo de autenticación necesario para conectarse a la base de datos de origen de sincronización. Ops Manager requiere este parámetro si el almacén de sincronización utiliza autenticación. Ops Manager devuelve uno de los siguientes: `MONGODB_CR` (Esto cubre SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-CR). `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
`clusterId`	string	Cadena de dígitos hexadecimales única 24que identifica el clúster que está configurado para copia de seguridad.
`encryptionEnabled`	booleano	Bandera que indica si el cifrado está habilitado para la configuración de respaldo.
`excludedNamespaces`	matriz de cadenas	Lista de nombres de bases de datos y colecciones omitidos en la copia de seguridad. Cada cadena especifica un espacio de nombres con el formato `{database}` o `{database}.{collection}`.
`groupId`	string	Cadena de dígitos hexadecimales 24única que identifica el proyecto que posee esta configuración de respaldo.
`includedNamespaces`	matriz de cadenas	Lista de nombres de bases de datos y colecciones incluidas en la copia de seguridad. Cada cadena especifica un espacio de nombres con el formato `{database}` `{database}.{collection}` o. No se incluirá en la copia de seguridad ningún espacio de nombres que no figure en esta matriz.
`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.
`multiRegionBackupEnabled`	booleano	Bandera que indica si la copia de seguridad multirregional está habilitada para el clúster.
`multiRegionMisconfigured`	booleano	Marca que indica si la copia de seguridad multirregión, si está siendo utilizada, se encuentra en el estado `Misconfigured`. El valor puede ser uno de los siguientes: `true` El estado es `Misconfigured` y Ops Manager no tomará nuevas instantáneas, aunque continúa con el seguimiento del registro de operaciones sin interrupciones para los miembros del clúster con regiones asignadas. Debe seleccionar una región de implementación para los nuevos miembros del clúster para que Ops Manager reanude la toma de nuevas instantáneas para todos los miembros del clúster. `false` - el estado es `Active`.
`preferredMember`	string	Miembro del clúster designado manualmente como miembro preferido para la copia de seguridad. Solo aparece en las solicitudes de miembro cuando el miembro preferido se configura con la interfazde usuario o la API.
`sslEnabled`	booleano	Bandera que indica si TLS está habilitado para la base de datos de origen de sincronización.
`statusName`	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`

Ejemplo de solicitud

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/?pretty=true"
     --data '
       {
         "multiRegionBackupEnabled" : true,
         "deploymentConfigs": [
           {"rsId":"myShard_2", "deploymentId":"NY_NJ"},
         ]
       }'

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

{
  "authMechanismName" : "NONE",
  "clusterId" : "{CLUSTER-ID}",
  "encryptionEnabled" : false,
  "excludedNamespaces" : [ ],
  "groupId" : "{PROJECT-ID}",
  "links" : [ ],
  "multiRegionBackupEnabled" : true,
  "multiRegionMisconfigured" : false,
  "sslEnabled" : false,
  "statusName" : "STARTED",
  "storageEngineName" : "WIRED_TIGER"
}

Volver

Crear por ID

Borrar