Docs Menu
Docs Home
/ /

Crear una configuración de almacén de bloques S3

Configura un nuevo almacén de bloques s3.

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

POST /snapshot/s3Configs

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Los siguientes parámetros de consulta son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Opcional

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

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

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

Nombre
Descripción

Estado

Código de respuestaHTTP

envolvente

Cuerpo de respuesta esperado

false

Nombre
Tipo
Necesidad
Descripción

Términos de servicio aceptados

booleano

Requerido

Marca que indica si aceptó o no los términos de servicio para usar almacenes de almacenamiento compatibles con S3 con Ops Manager. Debe establecerlo en true para crear un almacén de almacenamiento compatible con S3.

Si se establece en false, Ops Manager devuelve un error que indica que Ops Manager no puede crear el almacén de almacenamiento compatible con S3.

asignación habilitada

booleano

Opcional

Bandera que indica si puede asignar trabajos de respaldo a este almacén de datos.

awsAccessKey

string

Condicional

ID de clave de acceso deAWS que puede acceder al depósito de almacenamiento compatible con S3 especificado en s3BucketName.

Si "s3AuthMethod" : "IAM_ROLE" es, no es necesario incluir awsAccessKey.

clave secreta de aws

string

Condicional

Clave de acceso secreta deAWS que puede acceder al depósito de almacenamiento compatible con S3 especificado <s3BucketName> en.

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 depósito de almacenamiento compatible con S3 asociado.

certificados personalizados[n].nombrearchivo

string

Opcional

Nombre que identifica el archivo PEM de la Autoridad Certificadora.

certificados personalizados[n].certString

string

Opcional

Contenido del archivo de la Autoridad Certificadora PEM que conforma tu cadena de Autoridad Certificadora.

deshabilitarProxyS3

booleano

Opcional

Bandera que indica si el Se debe usarun proxy HTTP al conectarse a un 3almacenamiento compatible con S. No es necesario configurar este valor a menos que haya configurado Ops Manager para usarlo.

encryptedCredentials

booleano

Opcional

Bandera que indica si el nombre de usuario y la contraseña para este almacén de bloques de almacenamiento compatible con S3 se cifraron mediante la herramienta de credenciales.

ID.

string

Requerido

Nombre que identifica de forma única este almacén de instantáneas S.3

Etiquetas

matriz de cadenas

Opcional

Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de3 bloques S.

La configuración de estas etiquetas limita los trabajos de copia de seguridad que este almacén de almacenamiento compatible con S3 puede procesar. Si se omite, este almacén de almacenamiento compatible con S3 solo puede procesar trabajos de copia de seguridad de proyectos que no utilicen etiquetas para filtrar sus trabajos.

factor de carga

Número

Opcional

Entero positivo distinto de cero que expresa la cantidad de trabajo de copia de seguridad que realiza este almacén de instantáneas en comparación con otro. Esta opción solo es necesaria si se utilizan más de un almacén de instantáneas.

Para obtener más información sobre Load Factor,consulte Editar un almacén de bloques existente.

pathStyleAccessEnabled

booleano

Requerido

Bandera que indica el estilo de este punto final.

Valor
Estilo de punto final de S3 Blockstore
Ejemplo

true

Punto final de URL de estilo de ruta

s3.amazonaws.com/<bucket>

false

Punto final de URL de estilo de host virtual

<bucket>.s3.amazonaws.com

Para revisar las convenciones3 de URL de depósitos de almacenamiento compatibles con S, consulte la documentación de AWS S.3

Método de autenticación s3

string

Opcional

Método utilizado para autorizar el acceso al depósito de almacenamiento compatible con S3 especificado en s3BucketName.

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

KEYS o Ninguno

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

IAM_ROLE

Ops Manager utiliza un rol de IAM de AWS para autorizar el acceso al 3depósito de almacenamiento compatible con S especificado en s3BucketName. Los camposawsAccessKey y awsSecretKey se ignoran. Para obtener más información, consulte la documentación de AWS.

Punto final del cubo s3

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 almacén de bloques de almacenamiento compatible con S3.

Conexiones s3Max

Número

Requerido

Entero positivo que indica el número máximo de conexiones a este almacén de almacenamiento compatible con S3.

s3RegionOverride

string

Condicional

Región donde reside su depósito de almacenamiento compatible con S3.

Utilice este campo solo si el s3BucketEndpoint de su almacén de almacenamiento compatible con S3 no admite el ámbito regional. No utilice este campo con buckets de AWS S3.

sseHabilitado

booleano

Requerido

Bandera que indica si este3almacén de bloques de almacenamiento compatible con S habilita el cifrado del lado del servidor.

ssl

booleano

Opcional

Bandera que indica si este almacén de almacenamiento compatible con S3 solo acepta conexiones cifradas mediante TLS.

uri

string

Requerido

Cadena de conexión que conecta con la base de datos de metadatos de este almacén3de bloques de almacenamiento compatible con S. Esta base de datos almacena las ubicaciones de los bloques en el 3depósito de almacenamiento compatible con AWS S.

writeConcern

string

Opcional

Nivel de confirmación de escritura (write concern) utilizado por este almacenamiento en bloques.

Ops Manager acepta los siguientes valores:

  • ACKNOWLEDGED

  • W2

  • JOURNALED

  • MAJORITY

Para obtener más información sobre los niveles de reconocimiento de escritura en MongoDB, consulte Preocupación de escritura.

Nombre
Tipo
Descripción

Términos de servicio 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.

asignación habilitada

booleano

Bandera que indica si puede asignar trabajos de respaldo a este almacén de datos.

awsAccessKey

string

ID de clave de acceso deAWS que puede acceder al depósito de almacenamiento compatible con S3 especificado en s3BucketName.

clave secreta de aws

string

Clave de acceso secreta de AWS 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 depósito de almacenamiento compatible con S3 asociado.

certificados personalizados[n].nombrearchivo

string

Nombre que identifica el archivo PEM de la Autoridad Certificadora.

certificados personalizados[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

Bandera que indica si el nombre de usuario y la contraseña para este almacén de bloques de almacenamiento compatible con S3 se cifraron mediante la herramienta de credenciales.

ID.

string

Nombre que identifica de forma única este almacén de bloques de almacenamiento compatible con S3.

Etiquetas

matriz de cadenas

Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de3 bloques S.

enlaces

matriz de objetos

Uno o más enlaces a subrecursos o recursos relacionados. Todas las links matrices en las respuestas incluyen al menos un enlace self llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

factor de carga

entero

Entero positivo distinto de cero que expresa la cantidad de trabajo de copia de seguridad que realiza este almacén de instantáneas en comparación con otro. Esta opción solo es necesaria si se utilizan más de un almacén de instantáneas.

Para obtener más información Load Factor sobre, consulte Editar un almacén de bloques existente.

pathStyleAccessEnabled

booleano

Bandera que indica el estilo de este punto final.

Valor
Estilo de punto final de S3 Blockstore
Ejemplo

true

Punto final de URL de estilo de ruta

s3.amazonaws.com/<bucket>

false

Punto final de URL de estilo de host virtual

<bucket>.s3.amazonaws.com

Para revisar las convenciones3 de URL de depósitos de almacenamiento compatibles con S, consulte la documentación de AWS S.3

Método de autenticación s3

string

Método utilizado para autorizar el acceso al depósito de almacenamiento compatible con S3 especificado en s3BucketName.

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

KEYS o Ninguno

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

IAM_ROLE

Ops Manager utiliza un rol de IAM de AWS para autorizar el acceso al 3depósito de almacenamiento compatible con S especificado s3BucketName en. awsAccessKey Los awsSecretKey campos y se ignoran. Para obtener más información, consulte la documentación de AWS.

Punto final del cubo s3

string

URL que Ops Manager utiliza 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 almacén de bloques de almacenamiento compatible con S3.

Conexiones s3Max

entero

Entero positivo que indica el número máximo de conexiones a este almacén de almacenamiento compatible con S3.

s3RegionOverride

string

Región donde reside su bucket de almacenamiento compatible con S3. Este campo solo se aplica si el s3BucketEndpoint de su almacén de almacenamiento compatible con S3 no admite el alcance regional.

Ops Manager devuelve este campo solo si lo incluyó cuando creó o actualizó este almacén de bloques de almacenamiento compatible con S3.

sseHabilitado

booleano

Bandera que indica si este3almacén de bloques de almacenamiento compatible con S habilita el cifrado del lado del servidor.

ssl

booleano

Bandera que indica si este almacén de almacenamiento compatible con S3 solo acepta conexiones cifradas mediante TLS.

uri

string

Cadena de conexión que conecta con la base de datos de metadatos de este almacén3de bloques de almacenamiento compatible con S. Esta base de datos almacena las ubicaciones de los bloques en el 3depósito de almacenamiento compatible con AWS S.

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 más información sobre los niveles de reconocimiento de escritura en MongoDB, consulte Preocupación de escritura.

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