Docs Home

/ /

Almacenamiento Oplog

Docs Home

/ /

Administración de copias de seguridad

Almacenamiento Oplog

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Almacenamiento Oplog

Actualizar una configuración de Oplog

Actualiza la configuración de una tienda de oplog.

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

Resource

PUT /oplog/mongoConfigs/{OPLOG-CONFIG-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
OPLOG-CONFIG-ID	string	Identificador único para esta configuración de oplog.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
assignmentEnabled	booleano	Opcional. Indicador que indica si este almacen de oplog puede recibir tareas de copia de seguridad.
encryptedCredentials	booleano	opcional. Bandera que indica si el nombre de usuario y la contraseña de este almacén de Oplog fueron cifrados mediante la credentialstool.
etiquetas	Arreglo de cadenas	opcional. Arreglo de etiquetas para gestionar a qué tareas de copia de seguridad puede asignar el Ops Manager a qué repositorios de Oplog. La configuración de estas etiquetas limita qué tareas de copia de seguridad puede procesar este almacenamiento de registro de operaciones (oplog). Si se omite, este almacén de oplog solo puede procesar tareas de copia de seguridad para Proyectos que no utilicen etiquetas para filtrar sus trabajos.
maxCapacityGB	Número	opcional. La capacidad máxima disponible esperada de la tienda oplog para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. `maxCapacityGB` no aplica ningún límite en el tamaño de la base de datos de respaldo.
oidc	Objeto	Opcional. Configuración de autenticación OIDC para esta tienda. El objeto `oidc` acepta los siguientes campos: `enabled`: booleano. Habilita la autenticación OIDC para este almacenar. `method`: string. Uno de `callback`, `azure`, `gcp` o `k8s`. `tokenUri`: string. El proveedor de identidad punto final de token. Requerido cuando `method` es `callback`. `clientId`: string. El ID de cliente registrado con el proveedor de identidad. Obligatorio cuando `method` es `callback`; opcional cuando `method` es `azure`. `clientSecret`: string. El secreto del cliente registrado con el proveedor de identidad. Requerido cuando `method` es `callback`. Si edita un almacén existente y omite este campo o envía el valor redactado devuelto por una solicitud `GET` anterior, MongoDB Ops Manager conserva el secreto existente. `scope`: string. El ámbito de OAuth2 solicitado al proveedor de identidad. Se utiliza solo cuando `method` es `callback`. `tokenResource`: string. El público o identificador de recursos para el token de identidad de la carga de trabajo. Requerido cuando `method` es `azure` o `gcp`. Este valor debe coincidir con el `audience` configurado para este proveedor de identidad en la configuración `oidcIdentityProviders` de la implementación de MongoDB de destino. Los métodos `callback`, `azure`, `gcp` y `k8s` no requieren todos los mismos campos. Los métodos `azure`, `gcp` y `k8s` no requieren `clientSecret`. Cuando `oidc.enabled` es `true`, proporcione solo hosts y opciones de conexión en el campo `uri` del almacén. MongoDB Ops Manager ignora cualquier nombre de usuario o contraseña incrustados en la URI. Para cambiar una tienda de OIDC a otro mecanismo de autenticación, envíe `oidc: {enabled: false}` en la solicitud en lugar de omitir el objeto `oidc`.
uri	string	Una lista de hosts separada por comas en el formato `<hostname:port>` que se puede usar para acceder a esta oplog store.
ssl	booleano	Opcional. Indicador que señala si este almacén de oplog solo acepta conexiones encriptadas usando TLS.
writeConcern	string	opcional. El nivel de confirmación de escritura (write concern) utilizado para este oplog almacén. Los valores aceptados para esta opción son: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Para obtener información sobre los niveles de reconocimiento de escritura en MongoDB, consulta nivel de confirmación de escritura (write concern).

Respuesta

Nombre	Tipo	Descripción
assignmentEnabled	booleano	Bandera que indica si este almacenamiento de oplog se puede asignar a tareas de copia de seguridad.
encryptedCredentials	booleano	Indicador de si el nombre de usuario y la contraseña de esta tienda de oplog se cifraron usando la herramienta de credenciales .
ID	string	El nombre único que etiqueta esta tienda oplog.
etiquetas	Arreglo de cadenas	Arreglo de etiquetas para gestionar a qué tareas de copia de seguridad puede asignar Ops Manager en qué almacenes oplog.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos `links` en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre las URLse explican en la Especificación de enlace web.
maxCapacityGB	Número	opcional. La capacidad máxima disponible esperada de la tienda oplog para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. `maxCapacityGB` no aplica ningún límite en el tamaño de la base de datos de respaldo.
oidc	Objeto	Configuración de autenticación OIDC para esta tienda. El objeto `oidc` contiene los siguientes campos: `enabled`: booleano. Indica si la autenticación OIDC está habilitada para este almacén. `method`: string. Uno de `callback`, `azure`, `gcp` o `k8s`. `tokenUri`: string. El punto final del token del proveedor de identidad. Presente solo cuando `method` sea `callback`. `clientId`: string. El ID de cliente registrado con el proveedor de identidad. `clientSecret`: string. MongoDB Ops Manager redacta este valor en la respuesta y no devuelve el secreto de cliente sin procesar. `scope`: string. El ámbito de OAuth2 solicitado al proveedor de identidad. Solo presente cuando `method` es `callback`. `tokenResource`: string. El público o identificador de recursos para el token de identidad de la carga de trabajo. Presente solo cuando `method` sea `azure` o `gcp`.
uri	string	Una lista de hosts separada por comas en el formato `<hostname:port>` que se puede usar para acceder a esta oplog store.
ssl	booleano	Banderín que indica si esta tienda oplog solo acepta conexiones cifradas utilizando TLS.
usedSize	Número	La cantidad de capacidad de copia de seguridad en MB que consumen las copias de seguridad existentes.
writeConcern	string	El nivel de confirmación de escritura (write concern) utilizado para este almacenamiento del oplog. Los valores aceptados para esta opción son: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` Para obtener información sobre los niveles de reconocimiento de escritura en MongoDB, consulta nivel de confirmación de escritura (write concern).

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "labels" : [ "l1", "l2" ],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "writeConcern" : "W2"
}'

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,
  "encryptedCredentials" : false,
  "id" : "{CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

Volver

Crear

Borrar