/ /

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

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	string única de 24 dígitos hexadecimales que identifica el Proyecto que contiene el clúster con la configuración de copia de seguridad que deseas 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 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
`deploymentConfigs`	Arreglo de objetos	Requerido	Objetos de especificaciones para los nodos del clúster a los que 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á a la partición.
`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 fuente de sincronización. Ops Manager necesita este parámetro si el almacén de sincronización utiliza autenticación. Ops Manager devuelve una de las siguientes opciones: `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	Indicador que muestra si el cifrado está habilitado para la configuración de la copia de seguridad.
`excludedNamespaces`	Arreglo de cadenas	Lista de nombres de bases de datos y colecciones omitidos de la copia de seguridad. Cada string especifica un namespace con la forma `{database}` o `{database}.{collection}`.
`groupId`	string	string Única de 24 dígitos hexadecimales que identifica el Proyecto que posee esta configuración de copia de seguridad.
`includedNamespaces`	arreglo de string	Lista de nombres de bases de datos y de colecciones incluidas en la copia de seguridad. Cada string especifica un namespace de la forma `{database}` o `{database}.{collection}`. Cualquier namespace que no esté listado en este arreglo no será respaldado.
`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.
`multiRegionBackupEnabled`	booleano	Indicador que muestra si la copia de seguridad multiregión 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 snapshots, aunque Ops Manager continúa la supervisión del registro de operaciones (oplog tailing) sin interrupción para los nodos del clúster con regiones asignadas. Debes seleccionar una región de implementación para los nuevos nodos del clúster para que Ops Manager reanude la toma de nuevos snapshots para todos los nodos del clúster. `false` - el estado es `Active`.
`preferredMember`	string	Nodo del clúster designado manualmente como el nodo preferido para la copia de seguridad. Aparece solo para solicitudes de nodos cuando el nodo preferido se establece mediante la Interfaz de 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`

Solicitud de ejemplo

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"},
         ]
       }'

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

{
  "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