Configura un nuevo almacenamiento en bloques s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/s3ConfigsPará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. |
|
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 de AWS que puede acceder al bucket de almacenamiento compatible con S3especificado en s3BucketName. Si |
awsSecretKey | string | Condicional | AWS Clave de acceso secreta que puede acceder al bucket de almacenamiento compatible con S3especificado 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 | 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. |
ID | string | Requerido | Nombre que identifica de forma única este almacenamiento de snapshot S3. |
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. |
objectRetentionDays | entero | Opcional | Número de días que MongoDB Ops Manager protege los objetos de este almacenamiento en bloques de almacenamiento compatible con S3con bloqueo de objetos. Establezca este valor para que coincida con el período de retención por defecto configurado en el bucket de almacenamiento compatible con S3. Cuando guarda un almacenar con |
objectRetentionMode | string | Opcional | Moda de retención de bloqueo de objeto que Ops Manager aplica a los objetos de este almacenamiento en bloques compatible con S3. Establezca este valor para que coincida con la moda de retención configurada en el bucket de almacenamiento compatible con S3. Cuando guarda un almacenar con MongoDB Ops Manager acepta los siguientes valores para esta opción:
|
oidc | Objeto | Opcional | Opcional. Configuración de autenticación OIDC para este almacenar. El objeto
Los métodos Cuando Para cambiar un almacenar de OIDC a otro mecanismo de autenticación, envíe |
pathStyleAccessEnabled | booleano | Requerido | Bandera que indica el estilo de este endpoint.
Para revisar las convenciones de URL del bucket de almacenamiento compatible con S3, consulta 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. MongoDB Ops Manager acepta los siguientes valores para esta opción:
|
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 del almacenar de almacenamiento compatible con S3no admite la delimitación de regiones. No utilice este campo con los cubos S3 de AWS. |
sseEnabled | booleano | Requerido | Bandera que indica si este blockstore de almacenamiento compatible con S3, permite cifrado del lado del servidor. |
ssl | booleano | Opcional | Bandera que indica si este almacenamiento en bloques compatible con S3solo acepta conexiones cifradas mediante TLS. |
uri | string | Requerido | cadena de conexión que se conecta a la base de datos de metadatos para este almacenamiento en bloques compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el cubo de almacenamiento compatible con S3de AWS. |
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). |
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 de AWS que puede acceder al bucket de almacenamiento compatible con S3especificado en s3BucketName. |
awsSecretKey | string | AWS Clave de acceso secreta que puede acceder al bucket de almacenamiento compatible con S3especificado 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. |
objectLockEnabledAt | Marca de tiempo | Fecha y hora en que se habilitó el bloqueo de objetos para este almacenamiento en bloques compatible con S3. MongoDB Ops Manager devuelve este campo solo en respuesta a las solicitudes de |
objectRetentionDays | entero | Número de días que MongoDB Ops Manager protege los objetos de este almacenamiento en bloques de almacenamiento compatible con S3con bloqueo de objeto. |
objectRetentionMode | string | Moda de retención de bloqueo de objetos que MongoDB Ops Manager aplica a los objetos de este almacenamiento en bloques compatible con S3. Ops Manager devuelve uno de los siguientes valores:
|
oidc | Objeto | Configuración de autenticación OIDC para este almacenar. El objeto
|
pathStyleAccessEnabled | booleano | Bandera que indica el estilo de este endpoint.
Para revisar las convenciones de URL del bucket de almacenamiento compatible con S3, consulta 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 MongoDB 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 cuando creaste o actualizaste 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 | Bandera que indica si este almacenamiento en bloques compatible con S3solo acepta conexiones cifradas mediante TLS. |
uri | string | cadena de conexión que se conecta a la base de datos de metadatos para este almacenamiento en bloques compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el cubo de almacenamiento compatible con S3de AWS. |
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). |
Solicitud de ejemplo
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "awsAccessKey": "<access>", "awsSecretKey": "<secret>", "acceptedTos": true, "customCertificates" : [{ "filename" : "CA.pem", "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----" }], "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" }'curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \ --data '{ "id": "{S3-BLOCKSTORE-CONFIG-ID}", "assignmentEnabled": true, "pathStyleAccessEnabled": false, "acceptedTos": true, "encryptedCredentials": false, "loadFactor": 1, "s3AuthMethod": "IAM_ROLE", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "uri": "mongodb://127.0.0.1:27017", "ssl": false, "writeConcern": "ACKNOWLEDGED" }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "acceptedTos": true, "assignmentEnabled": true, "awsAccessKey": "<access>", "awsSecretKey": "<secret>", "customCertificates" : [{ "filename" : "CA.pem", "certString" : "-----BEGIN CERTIFICATE-----\nMIIDljCCAn4CCQDJjCHAkAafFTANBgkqhkiG9w0BAQsFADCBjDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAk5ZMQwwCgYDVQQHDANOWUMxEDAOBgNVBAoMB01vbmdvREIx\nDDAKBgNVBAsMA1NXRTEZMBcGA1UEAwwQZXJpbm1jbnVsdHkudGVjaDEnMCUGCSqG\nSIb3DQEJARYYZXJpbi5tY251bHR5QG1vbmdvZGIuY29tMB4XDTIxMDYxMTE1MzY0\nMVoXDTIxMDcxMTE1MzY0MVowgYwxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOWTEM\nMAoGA1UEBwwDTllDMRAwDgYDVQQKDAdNb25nb0RCMQwwCgYDVQQLDANTV0UxGTAX\nBgNVBAMMEGVyaW5tY251bHR5LnRlY2gxJzAlBgkqhkiG9w0BCQEWGGVyaW4ubWNu\ndWx0eUBtb25nb2RiLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAOoAv1btxcEgDOdCgyz+/NtyFwa0h/3yGtj+WK7nMzcEntnxG5apHVRZ6eQ4ayZU\nhZNPbNWtcsbTEiRWyywMAd7/DbIa9GhsP1/P6Cv+TnO2krx8qVKQN93j8cme/b6g\n+yeEWMAM2rvfXq/fRTtJbH1Y6c4mYh4312mPrlEfgvAUQZh3DpJQNIVZ5MM2imp0\nfBgcggrNHUniLCT8ogUA4QII8CKIC4ONX4TNtXbsNtcCzKNqvOdcvWXLTYEJav34\nlaJs1YWJx2PSufgHo+JZUeANwwpztkYhr3nUGTD8fr7JF9CO7UlFBTFqs+PeaTJV\nEbnrF26NimsAmRgRPNLE170CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAe5hAkrhz\nClXg4HPq6U3ONEUVUqQ231gogeUIIQsfn4K89QIFnsm0DC1lE21qHNcD3iHECmDJ\n9R2tXdA0shbc+hM8OHbEW6U31dLrM369PUQmw0GOkFWlYHnX4ySt+zMAjlIrQe7C\nLErYSuLDpjuKvkdpvbcwgkarB9/FPCOhORpAZqduhwUOr28tZzT3/8L7w//+7Yhy\n5ihKgTcP/CmJ+MgLlZqBtQ7lkmKDWXIUlLSRDHEciVGSXgZBreUciNFeMHVvoluc\ndxdsxqMcXgyXwmv7Ck7tCjYRwzwlf3TrcKt8QFijWTbl1Z/3d0/zpjuvR21J0z/3\ns4tNMtQdG6/bHA==\n-----END CERTIFICATE-----" }], "encryptedCredentials": false, "id": "{S3-BLOCKSTORE-CONFIG-ID}", "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", "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"}{ "acceptedTos": true, "assignmentEnabled": true, "encryptedCredentials": false, "id": "{S3-BLOCKSTORE-CONFIG-ID}", "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs", "rel": "self" } ], "loadFactor": 1, "pathStyleAccessEnabled": false, "s3AuthMethod": "IAM_ROLE", "s3BucketEndpoint": "s3.amazonaws.com", "s3BucketName": "bucketname", "s3MaxConnections": 50, "sseEnabled": true, "ssl": false, "uri": "mongodb://127.0.0.1:27017", "writeConcern": "ACKNOWLEDGED"}