Actualizar la configuración de One S3 almacenamiento en bloques (v2.0)

Actualiza una configuración de almacenamiento en bloques compatible con S3. El recurso v2.0 agrega el objeto keyVault. Con este objeto, el almacenamiento en bloques compatible con S3 lee sus credenciales de AWS desde HashiCorp Vault. Para obtener más información, consulte HashiCorp Vault para credenciales de almacenamiento de instantáneas.

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

Resource

PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
S3-BLOCKSTORE-CONFIG-ID	string	El nombre único que etiqueta esta configuración de almacenamiento en bloques compatible con S3.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta está en formato legible.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, establezca envelope=true en la consulta. 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	Necesidad	Descripción
Términos aceptados	booleano	Requerido	Indicador que especifica si ha aceptado los términos de servicio para el uso de almacenes de almacenamiento compatibles con S3con Ops Manager. Debe establecer esto en `true` para crear un almacén de almacenamiento compatible con S3. Si estableces este valor en `false`, el Administrador de operaciones devuelve un error. El error indica que Ops Manager no puede crear el almacén de almacenamiento compatible con S3.
assignmentEnabled	booleano	Opcional	Indicador que señala si puede asignar tareas de copia de seguridad a este almacén de datos.
awsAccessKey	string	Condicional	ID de clave de acceso deAWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName. Si `"s3AuthMethod" : "IAM_ROLE"`, entonces no es necesario incluir awsAccessKey.
awsSecretKey	string	Condicional	Clave de acceso secreta de AWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en `<s3BucketName>`. Si `"s3AuthMethod" : "IAM_ROLE"`, entonces no es necesario incluir awsSecretKey.
cerfiticados personalizados	arreglo	Opcional	Lista de certificados de autoridad de certificación válidos que se aplican al bucket de almacenamiento compatible con S3 asociado.
customCertificates[n].filename	string	Opcional	Nombre que identifica el archivo PEM de la Autoridad de Certificación.
customCertificates[n].certString	string	Opcional	Contenido del archivo de la Autoridad Certificadora PEM que conforma tu cadena de Autoridad Certificadora.
deshabilitarProxyS3	booleano	Requerido	Al conectarse a un almacenamiento compatible con S3, indica si se debe usar el HTTP proxy. Debe incluir este campo en cada solicitud para crear o actualizar un almacenamiento en bloques compatible con S3, incluso si no ha configurado MongoDB Ops Manager para usar el HTTP proxy.
encryptedCredentials	booleano	Opcional	Indicador que señala si el nombre de usuario y la contraseña para este almacenamiento compatible con S3 se cifraron utilizando la herramienta de credenciales.
etiquetas	Arreglo de cadenas	Opcional	Conjunto de etiquetas para gestionar qué trabajos de copia de seguridad puede asignar Ops Manager a qué almacenes de bloques S3. Si se establece estas etiquetas se limitan qué tareas de copia de seguridad puede procesar esta tienda de almacenamiento compatible con S3. Si se omite, este almacenamiento en bloques compatible con S3 solo puede procesar tareas de copia de seguridad para proyectos que no utilizan etiquetas para filtrar sus tareas.
factor de carga	Número	Opcional	Un número entero positivo no nulo que expresa la cantidad de trabajo de copia de seguridad que esta almacenamiento de snapshot realiza en comparación con otro almacenamiento de instantáneas. 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.
objectLockEnabled	booleano	Opcional	Bandera que indica si el bloqueo de objetos está habilitado para evitar que los objetos en un bucket S3 se eliminen.
oidc	Objeto	Opcional	Opcional. Configuraciónde autenticación OIDC para este almacén. El objeto `oidc` acepta los siguientes campos: `enabled`: booleano. Habilita la autenticación OIDC para este almacén. `method`: string. Uno de `callback`, `azure`, `gcp` o `k8s`. `tokenUri`: cadena. El punto final del token del IdP. Obligatorio cuando `method` es `callback`. `clientId`: cadena. El ID de cliente registrado con el IdP. Obligatorio cuando `method` es `callback`; opcional cuando `method` es `azure`. `clientSecret`: cadena. El secreto del cliente registrado con el IdP. Obligatorio cuando `method` es `callback`. Si edita un almacén existente y omite este campo o envía el valor censurado devuelto por una solicitud `GET` anterior, Ops Manager conserva el secreto existente. `scope`: cadena. El ámbito OAuth2 solicitado al IdP. Se utiliza solo cuando `method` es `callback`. `tokenResource`: cadena. El identificador de audiencia o recurso para el token de identidad de la carga de trabajo. Obligatorio cuando `method` es `azure` o `gcp`. Este valor debe coincidir con el `audience` configurado para este IdP 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`. Si actualiza este almacén y omite el objeto `oidc` de la solicitud, Ops Manager eliminará la configuración OIDC existente. Para conservar la configuración existente, incluya el objeto `oidc` actual en cada solicitud de actualización. `clientSecret` es la única excepción. Si omite `clientSecret` del objeto `oidc` o envía el valor redactado devuelto por una solicitud `GET` anterior, MongoDB Ops Manager conserva el secreto existente. Para cambiar el secreto, envíe el nuevo valor de texto sin formato.
pathStyleAccessEnabled	booleano	Requerido	Bandera que indica el estilo de este endpoint. `true`: punto final de URL con formato de ruta. Por ejemplo, `s3.amazonaws.com/<bucket>`. `false`: punto final URL de estilo host virtual. Por ejemplo, `<bucket>.s3.amazonaws.com`. Para revisar las convenciones de URL de los buckets de almacenamiento compatibles con S3, consulte la documentación de AWS S3.
s3AuthMethod	string	Opcional	Método utilizado para autorizar el acceso al bucket de almacenamiento compatible con S3 especificado en s3BucketName. Ops Manager acepta los valores siguientes: `KEYS` o Ninguno: MongoDB Ops Manager utiliza awsAccessKey y awsSecretKey para autorizar el acceso a un cubo de almacenamiento compatible con S3especificado en s3BucketName. `IAM_ROLE`Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3 especificado en s3BucketName. Los camposawsAccessKey y awsSecretKey se ignoran. Para obtener más información, consulte la documentación de AWS.
s3BucketEndpoint	string	Requerido	URL utilizada para acceder a este depósito de almacenamiento compatible con S3.
s3BucketName	string	Requerido	Nombre del depósito de almacenamiento compatible con S3 que aloja el almacenamiento en bloques compatible con S3.
s3MaxConnections	Número	Requerido	Entero positivo que indica el número máximo de conexiones a este almacenamiento de bloques compatible con S3.
s3RegionOverride	string	Condicional	Región donde se encuentra su bucket de almacenamiento compatible con S3. Utilice este campo únicamente si el s3BucketEndpoint de su almacén compatible con S3 no admite la definición de ámbito regional. No utilice este campo con buckets de AWS S3.
sseEnabled	booleano	Requerido	Bandera que indica si este blockstore de almacenamiento compatible con S3, permite cifrado del lado del servidor.
uri	string	Requerido	Lista separada por comas de hosts en formato `<hostname:port>` que pueden acceder a este blockstore de almacenamiento compatible con S3.
ssl	booleano	Opcional	Indicador que especifica si este almacén de bloques de almacenamiento compatible con S3 solo acepta conexiones cifradas mediante TLS.
writeConcern	string	Opcional	Nivel de confirmación de escritura (write concern) utilizado por este almacenamiento en bloques. Ops Manager acepta los valores siguientes: `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).

Nota

Cuando s3AuthMethod es KEYS, proporcione exactamente una de las siguientes fuentes de credenciales: el objeto keyVault, o awsAccessKey y awsSecretKey. Cuando s3AuthMethod es IAM_ROLE, no proporcione el objeto keyVault. MongoDB Ops Manager devuelve un error si lo hace e ignora cualquier valor awsAccessKey y awsSecretKey.

El recurso v2.0 agrega los siguientes parámetros de Key Vault:

Nombre	Tipo	Necesidad	Descripción
keyVault	Objeto	Condicional	Fuente de credenciales respaldada por Vault para este almacenamiento de snapshot compatible con S3. Cuando `s3AuthMethod` es `KEYS`, proporcione el objeto `keyVault` o `awsAccessKey` y `awsSecretKey`, pero no ambos. Para obtener más información, consulte HashiCorp Vault para credenciales de almacenamiento de snapshot.
keyVault.vaultId	string	Condicional	Identificador único de la configuración de la bóveda de claves que almacena las credenciales. Este valor coincide con el `id` de una configuración de bóveda de claves. Requerido cuando proporcionas `keyVault`.
keyVault.awsAccessKeyPath	string	Condicional	Ruta a la clave de acceso de AWS en el almacén de claves, en el formato `<secret-path>/<key>`. Ops Manager lee el valor del campo `<key>` del secreto de la versión 2 del almacén de claves en `<secret-path>`. Por ejemplo, `secret/data/s3/aws-access-key` lee el campo `aws-access-key` del secreto en `secret/data/s3`. Incluya el segmento `/data/` que requiere la versión 2 del almacén de claves. No incluya el prefijo de API `/v1/`. Ops Manager agrega el prefijo automáticamente. Obligatorio cuando proporciona `keyVault`.
keyVault.awsSecretKeyPath	string	Condicional	Ruta a la clave secreta de AWS en el almacén de claves. Utiliza el mismo formato `<secret-path>/<key>` que `keyVault.awsAccessKeyPath`. Obligatorio cuando se proporciona `keyVault`.

Respuesta

Nombre	Tipo	Descripción
Términos aceptados	booleano	Indicador que muestra si aceptaste los términos de servicio para usar almacenamiento compatible con S3con MongoDB Ops Manager. Debe establecerlo en `true` para crear un almacén de almacenamiento compatible con S3.
assignmentEnabled	booleano	Indicador que señala si puede asignar tareas de copia de seguridad a este almacén de datos.
awsAccessKey	string	ID de clave de acceso deAWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName.
awsSecretKey	string	Clave de acceso secreta deAWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName.
cerfiticados personalizados	arreglo	Lista de certificados de autoridad de certificación válidos que se aplican al bucket de almacenamiento compatible con S3 asociado.
customCertificates[n].filename	string	Nombre que identifica el archivo PEM de la Autoridad de Certificación.
customCertificates[n].certString	string	Contenido del archivo de la Autoridad Certificadora PEM que conforma tu cadena de Autoridad Certificadora.
deshabilitarProxyS3	booleano	Indicador que indica si se debe utilizar el HTTP proxy al conectar con un almacenamiento compatible con S3.
encryptedCredentials	booleano	Indicador que señala si el nombre de usuario y la contraseña para este almacenamiento compatible con S3 se cifraron utilizando la herramienta de credenciales.
ID	string	Nombre que identifica de manera única a este almacenamiento en bloques compatible con S3.
etiquetas	Arreglo de cadenas	Conjunto de etiquetas para gestionar qué trabajos de copia de seguridad puede asignar Ops Manager a qué almacenes de bloques S3.
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 URLse explican en la Especificación de enlaces web.
factor de carga	entero	Un número entero positivo no nulo que expresa la cantidad de trabajo de copia de seguridad que esta almacenamiento de snapshot realiza en comparación con otro almacenamiento de instantáneas. 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.
objectLockEnabled	booleano	Bandera que indica si el bloqueo de objetos está habilitado para evitar que los objetos en un bucket S3 se eliminen.
oidc	Objeto	Configuraciónde autenticación OIDC para este almacén. 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`: cadena. El punto final del token IdP. Presente solo cuando `method` es `callback`. `clientId`: cadena. El ID de cliente registrado con el IdP. `clientSecret`: string. MongoDB Ops Manager redacta este valor en la respuesta y no devuelve el secreto de cliente sin procesar. `scope`: cadena. El ámbito OAuth2 solicitado al IdP. Presente solo 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`.
pathStyleAccessEnabled	booleano	Bandera que indica el estilo de este endpoint. `true`: Punto final de URL con formato de ruta. Ejemplo: `s3.amazonaws.com/<bucket>` `false`: Punto final URL de estilo host virtual. Ejemplo: `<bucket>.s3.amazonaws.com` Para revisar las convenciones de URL de los buckets de almacenamiento compatibles con S3, consulte la documentación de AWS S3.
s3AuthMethod	string	Método utilizado para autorizar el acceso al bucket de almacenamiento compatible con S3 especificado en `s3BucketName`. Los valores aceptados para esta opción son: `KEYS`, `IAM_ROLE`. `KEYS` o Ninguno: Ops Manager utiliza `awsAccessKey` y `awsSecretKey` para autorizar el acceso al cubo de almacenamiento compatible con S3especificado en `s3BucketName`. `IAM_ROLE`Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3 especificado en `s3BucketName`. Los campos `awsAccessKey` y `awsSecretKey` se ignoran. Para obtener más información, consulte la documentación de AWS.
s3BucketEndpoint	string	URL que utiliza Ops Manager para acceder a este depósito de almacenamiento compatible con S3.
s3BucketName	string	Nombre del depósito de almacenamiento compatible con S3 que aloja el almacenamiento en bloques compatible con S3.
s3MaxConnections	entero	Entero positivo que indica el número máximo de conexiones a este almacenamiento de bloques compatible con S3.
s3RegionOverride	string	Región donde reside tu bucket de almacenamiento compatible con S3. Este campo solo se aplica si el s3BucketEndpoint de su almacenamiento compatible con S3 no admite el alcance regional. Ops Manager devuelve este campo solo si lo incluiste al crear o actualizar este bloque de almacenamiento compatible con S3.
sseEnabled	booleano	Bandera que indica si este blockstore de almacenamiento compatible con S3, permite cifrado del lado del servidor.
ssl	booleano	Indicador que especifica si este almacén de bloques de almacenamiento compatible con S3 solo acepta conexiones cifradas mediante TLS.
uri	string	Cadena de conexión que se conecta a la base de datos de metadatos para este almacén de bloques de almacenamiento compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el bucket de almacenamiento compatible con AWS S3.
writeConcern	string	Nivel de confirmación de escritura (write concern) utilizado por este almacenamiento en bloques. Ops Manager devuelve uno de los siguientes valores: `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).

El recurso v2.0 agrega el siguiente campo de bóveda de claves:

Nombre	Tipo	Descripción
keyVault	Objeto	Fuente de credenciales respaldada por Vault para este almacenamiento de snapshot compatible con S3. MongoDB Ops Manager devuelve este objeto solo cuando el almacenamiento de snapshot lee sus credenciales de un almacén de claves.
keyVault.vaultId	string	Identificador único de la configuración del almacén de claves que almacena las credenciales.
keyVault.awsAccessKeyPath	string	Ruta en el almacén de claves a la clave de acceso de AWS.
keyVault.awsSecretKeyPath	string	Ruta en el almacén de claves a la clave secreta de AWS.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
     --data '{
       "assignmentEnabled": true,
       "pathStyleAccessEnabled": false,
       "acceptedTos": true,
       "encryptedCredentials": false,
       "loadFactor": 1,
       "s3AuthMethod": "KEYS",
       "s3BucketEndpoint": "s3.amazonaws.com",
       "s3BucketName": "bucketname",
       "s3MaxConnections": 50,
       "sseEnabled": true,
       "uri": "mongodb://127.0.0.1:27017",
       "ssl": false,
       "writeConcern": "ACKNOWLEDGED",
       "keyVault": {
         "vaultId": "{KEY-VAULT-ID}",
         "awsAccessKeyPath": "path/to/awsAccessKey",
         "awsSecretKeyPath": "path/to/awsSecretKey"
       }
     }'

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

{
  "acceptedTos": true,
  "assignmentEnabled": true,
  "encryptedCredentials": false,
  "id": "{S3-BLOCKSTORE-CONFIG-ID}",
  "keyVault": {
    "vaultId": "{KEY-VAULT-ID}",
    "awsAccessKeyPath": "path/to/awsAccessKey",
    "awsSecretKeyPath": "path/to/awsSecretKey"
  },
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "loadFactor": 1,
  "pathStyleAccessEnabled": false,
  "s3AuthMethod": "KEYS",
  "s3BucketEndpoint": "s3.amazonaws.com",
  "s3BucketName": "bucketname",
  "s3MaxConnections": 50,
  "sseEnabled": true,
  "ssl": false,
  "uri": "mongodb://127.0.0.1:27017",
  "writeConcern": "ACKNOWLEDGED"
}

Volver

Crear

Borrar