Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

Crear una configuración de almacenamiento en bloques S3

Configura un nuevo almacenamiento en bloques s3.

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

POST /snapshot/s3Configs

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

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuesta HTTP

content

Cuerpo de respuesta esperado

false

Nombre
Tipo
Necesidad
Descripción

Términos aceptados

booleano

Requerido

Indicador que señala si has aceptado o no los términos de uso para usar almacenes de almacenamiento compatibles con S3 con Ops Manager. Debes 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 AWS 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

AWS Clave de acceso secreta 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

Opcional

Indicador que muestra si la Se debe usar un HTTP proxy al conectarse a un almacenamiento compatible con S3. No necesitas configurar este valor a menos que hayas configurado 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 aprender más acerca de Load Factor, consulta 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.

pathStyleAccessEnabled

booleano

Requerido

Bandera que indica el estilo de este endpoint.

Valor
Estilo del endpoint de almacenamiento en bloques de S3
Ejemplo

true

Punto final de URL con estilo de ruta

s3.amazonaws.com/<bucket>

false

Punto final de URL de estilo host virtual

<bucket>.s3.amazonaws.com

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.

Los valores aceptados para esta opción son: KEYS, IAM_ROLE.

KEYS o ninguno

Ops Manager utiliza awsAccessKey y awsSecretKey para autorizar el acceso a un depósito de almacenamiento compatible con S3 especificado en s3BucketName.

IAM_ROLE

Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3especificado en s3BucketName. Los campos awsAccessKey y awsSecretKey se pasan por alto. Para obtener más información, consulta la documentación de AWS

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.

ssl

booleano

Opcional

Indicador que señala si este almacenamiento de bloque compatible con S3 sólo acepta conexiones cifradas mediante TLS.

uri

string

Requerido

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

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).

Nombre
Tipo
Descripción

Términos aceptados

booleano

Indicador que indica si aceptaste o no los términos de servicio para utilizar almacenamiento compatible con S3 con Ops Manager. Debes 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 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 usar el proxy HTTP al conectarse al 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 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

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.

pathStyleAccessEnabled

booleano

Bandera que indica el estilo de este endpoint.

Valor
Estilo del endpoint de almacenamiento en bloques de S3
Ejemplo

true

Punto final de URL con estilo de ruta

s3.amazonaws.com/<bucket>

false

Punto final de URL de estilo host virtual

<bucket>.s3.amazonaws.com

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 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 almacenamiento compatible con S3 especificado en s3BucketName.

IAM_ROLE

Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3especificado en s3BucketName. Se ignoran los campos awsAccessKey y awsSecretKey. Para obtener más información, consulta la documentación de AWS

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:

  • 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).

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6 --data '{
7 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8 "assignmentEnabled": true,
9 "pathStyleAccessEnabled": false,
10 "awsAccessKey": "<access>",
11 "awsSecretKey": "<secret>",
12 "acceptedTos": true,
13 "customCertificates" : [{
14 "filename" : "CA.pem",
15 "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-----"
16 }],
17 "encryptedCredentials": false,
18 "loadFactor": 1,
19 "s3AuthMethod": "KEYS",
20 "s3BucketEndpoint": "s3.amazonaws.com",
21 "s3BucketName": "bucketname",
22 "s3MaxConnections": 50,
23 "sseEnabled": true,
24 "uri": "mongodb://127.0.0.1:27017",
25 "ssl": false,
26 "writeConcern": "ACKNOWLEDGED"
27 }'
1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true' \
6 --data '{
7 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
8 "assignmentEnabled": true,
9 "pathStyleAccessEnabled": false,
10 "acceptedTos": true,
11 "encryptedCredentials": false,
12 "loadFactor": 1,
13 "s3AuthMethod": "IAM_ROLE",
14 "s3BucketEndpoint": "s3.amazonaws.com",
15 "s3BucketName": "bucketname",
16 "s3MaxConnections": 50,
17 "sseEnabled": true,
18 "uri": "mongodb://127.0.0.1:27017",
19 "ssl": false,
20 "writeConcern": "ACKNOWLEDGED"
21 }'
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}
1{
2 "acceptedTos": true,
3 "assignmentEnabled": true,
4 "awsAccessKey": "<access>",
5 "awsSecretKey": "<secret>",
6 "customCertificates" : [{
7 "filename" : "CA.pem",
8 "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-----"
9 }],
10 "encryptedCredentials": false,
11 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
12 "links": [
13 {
14 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
15 "rel": "self"
16 }
17 ],
18 "loadFactor": 1,
19 "pathStyleAccessEnabled": false,
20 "s3AuthMethod": "KEYS",
21 "s3BucketEndpoint": "s3.amazonaws.com",
22 "s3BucketName": "bucketname",
23 "s3MaxConnections": 50,
24 "sseEnabled": true,
25 "ssl": false,
26 "uri": "mongodb://127.0.0.1:27017",
27 "writeConcern": "ACKNOWLEDGED"
28}
1{
2 "acceptedTos": true,
3 "assignmentEnabled": true,
4 "encryptedCredentials": false,
5 "id": "{S3-BLOCKSTORE-CONFIG-ID}",
6 "links": [
7 {
8 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
9 "rel": "self"
10 }
11 ],
12 "loadFactor": 1,
13 "pathStyleAccessEnabled": false,
14 "s3AuthMethod": "IAM_ROLE",
15 "s3BucketEndpoint": "s3.amazonaws.com",
16 "s3BucketName": "bucketname",
17 "s3MaxConnections": 50,
18 "sseEnabled": true,
19 "ssl": false,
20 "uri": "mongodb://127.0.0.1:27017",
21 "writeConcern": "ACKNOWLEDGED"
22}

Volver

Obtener todo

En esta página