Docs Home

/ /

Blockstore

Docs Home

/ /

Administración de copias de seguridad

Blockstore

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Blockstore

Cree una configuración de almacenamiento en bloques

Configura un nuevo almacenamiento en bloques.

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

Resource

POST /snapshot/mongoConfigs

Parámetros de ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

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 de si a este almacenamiento en bloques se le pueden asignar tareas de copia de seguridad.
encryptedCredentials	booleano	opcional. Indicador que señala si el nombre de usuario y la contraseña de este almacenamiento en bloques se han cifrado utilizando la herramienta de credenciales.
ID	string	El nombre único que identifica este almacenamiento en bloques.
etiquetas	Arreglo de cadenas	opcional. Arreglo de etiquetas para gestionar a qué tareas de copia de seguridad puede asignar Ops Manager a cuál almacén de bloques. Configurar estas etiquetas limita las tareas de copia de seguridad que este almacenamiento en bloques puede procesar. Si se omite, este almacenamiento en bloques solo puede procesar tareas de copia de seguridad para proyectos que no utilizan etiquetas para filtrar sus trabajos.
factor de carga	Número	opcional. Un entero positivo distinto de cero que expresa cuánto trabajo de copia de seguridad debe realizar este almacenamiento de snapshot en comparación con otro almacenamiento de snapshot. Esta opción solo es necesaria si se utiliza más de un almacenamiento de snapshot. Para obtener más información sobre Load Factor, consulte Editar un almacenamiento en bloques existente.
maxCapacityGB	Número	opcional. La capacidad máxima disponible esperada del almacenamiento en bloques 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 separada por comas de hosts en el formato `<hostname:port>` que se pueden utilizar para acceder a este almacenamiento en bloques.
ssl	booleano	opcional. Indicador que muestra si este almacenamiento en bloques sólo acepta conexiones cifradas mediante TLS.
writeConcern	string	opcional. El nivel de confirmación de escritura (write concern) utilizado para este almacenamiento en bloques. 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	Indicador que señala si este almacenamiento en bloques puede asignarse a tareas de copia de seguridad.
encryptedCredentials	booleano	Indicador que señala si el nombre de usuario y la contraseña de este almacenamiento en bloques se cifraron mediante la credentialstool.
ID	string	El nombre único que identifica este almacenamiento en bloques.
etiquetas	Arreglo de cadenas	Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué blockstores.
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.
factor de carga	Número	Un entero positivo y diferente de cero que expresa cuánto trabajo de copia de seguridad debe realizar este almacenamiento de snapshot en comparación con otro almacenamiento de snapshot. Esta opción solo es necesaria si se utiliza más de un almacenamiento de snapshot. Para obtener más información sobre Load Factor, consulte Editar un almacenamiento en bloques existente.
maxCapacityGB	Número	opcional. La capacidad máxima disponible esperada del almacenamiento en bloques 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 separada por comas de hosts en el formato `<hostname:port>` que se pueden utilizar para acceder a este almacenamiento en bloques.
ssl	booleano	Indicador de si este almacenamiento en bloques sólo 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 en bloques. 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

1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true' \
6      --data '{
7          "assignmentEnabled" : true,
8          "encryptedCredentials" : false,
9          "id" : "{BLOCKSTORE-CONFIG-ID}",
10          "labels" : [ "l1", "l2" ],
11          "loadFactor" : 2,
12          "maxCapacityGB" : 8,
13          "uri" : "mongodb://localhost:27017",
14          "ssl" : true,
15          "writeConcern" : "W2"
16        }'

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

1 {
2   "assignmentEnabled" : true,
3   "encryptedCredentials" : false,
4   "id" : "{BLOCKSTORE-CONFIG-ID}",
5   "labels" : [ "l1", "l2" ],
6   "links" : [ {
7     "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs",
8     "rel" : "self"
9   }],
10   "loadFactor" : 2,
11   "maxCapacityGB" : 8,
12   "uri" : "mongodb://localhost:27017",
13   "ssl" : true,
14   "usedSize" : 222,
15   "writeConcern" : "W2"
16 }

Volver

Obtener todo

Update

1	curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true' \
6	--data '{
7	"assignmentEnabled" : true,
8	"encryptedCredentials" : false,
9	"id" : "{BLOCKSTORE-CONFIG-ID}",
10	"labels" : [ "l1", "l2" ],
11	"loadFactor" : 2,
12	"maxCapacityGB" : 8,
13	"uri" : "mongodb://localhost:27017",
14	"ssl" : true,
15	"writeConcern" : "W2"
16	}'