Actualiza una configuración de almacenamiento en bloques compatible con S3. El recurso v2.0 añade el objeto keyVault. Con este objeto, el almacenamiento en bloques compatible con S3lee sus credenciales de Amazon Web Services de HashiCorp Vault. Para obtener más información, consulte HashiCorp Vault para credenciales de almacenamiento de snapshot.
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 muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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:
|
|
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 Si estableces este valor en | |||||||||
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 AWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName. Si | |||||||||
awsSecretKey | string | Condicional | AWS Clave de acceso secreta que puede acceder al bucket de almacenamiento compatible con S3 especificado en Si | |||||||||
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 | Opcional | Indicador que indica si se debe usar el HTTP proxy al conectarse a un almacenamiento compatible con S3. No necesitas configurar este valor a menos que hayas 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 | Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué almacenamientos en bloque 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ón de autenticación OIDC para esta tienda. El objeto
Los métodos Cuando Para cambiar una tienda de OIDC a otro mecanismo de autenticación, envíe Si actualiza este almacenamiento y omite el objeto
| |||||||||
pathStyleAccessEnabled | booleano | Requerido | Bandera que indica el estilo de este endpoint.
Para revisar las convenciones del bucket de almacenamiento URL compatible 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:
| |||||||||
s3BucketEndpoint | string | Requerido | URL utilizada para acceder a este bucket 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 solo si el s3BucketEndpoint de su almacén de almacenamiento compatible con S3 no admite el alcance regional. No uses este campo con los bucket 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 | |||||||||
ssl | booleano | Opcional | Indicador que señala si este almacenamiento de bloque compatible con S3 sólo 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:
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 |
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 |
keyVault.awsAccessKeyPath | string | Condicional | Ruta a la clave de acceso de AWS en el almacén de claves, en el formato |
keyVault.awsSecretKeyPath | string | Condicional | Ruta a la llave secreta de Amazon Web Services en el almacén de llaves. Utiliza el mismo formato |
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 | |||||||||
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 AWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName. | |||||||||
awsSecretKey | string | AWS Clave de acceso secreto que puede acceder al depósito 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 | Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué almacenamientos en bloque S3. | |||||||||
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos | |||||||||
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ón de autenticación OIDC para esta tienda. El objeto
| |||||||||
pathStyleAccessEnabled | booleano | Bandera que indica el estilo de este endpoint.
Para revisar las convenciones del bucket de almacenamiento URL compatible 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 Los valores aceptados para esta opción son:
| |||||||||
s3BucketEndpoint | string | URL que Ops Manager utiliza para acceder a este bucket 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 señala si este almacenamiento de bloque compatible con S3 sólo acepta conexiones cifradas mediante TLS. | |||||||||
uri | string | Cadena de conexión que conecta a la base de datos de metadatos para este bloque de almacenamiento compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el AWS depósito de almacenamiento compatible con 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:
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 Amazon Web Services. |
keyVault.awsSecretKeyPath | string | Ruta en el almacén de claves a la clave secreta de Amazon Web Services. |
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
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
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" }