Configura un nuevo almacén de oplog s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /oplog/s3Configs
Pará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 señala si el cuerpo de la respuesta debe estar en un pretty-print formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
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 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 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 muestra si el nombre de usuario y la contraseña de este almacén oplog de almacenamiento compatible con S3fueron cifrado utilizando credentialstool. | |||||||||
ID | string | Requerido | Nombre que identifica de manera única esta tienda oplog de almacenamiento compatible con S3. | |||||||||
etiquetas | Arreglo de cadenas | Opcional | Matriz de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué tiendas oplog S3. Configurar estas etiquetas limita qué tareas de copia de seguridad puede procesar esta tienda de oplog de almacenamiento compatible con S3. Si se omite, este almacenamiento de Oplog compatible con S3sólo puede procesar tareas de copia de seguridad para Proyectos que no utilicen etiquetas para filtrar sus tareas. | |||||||||
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 S3que aloja el almacén de registro de operaciones compatible con S3. | |||||||||
s3MaxConnections | Número | Requerido | Número entero positivo que indica el número máximo de conexiones a este almacén compatible con S3para almacenamiento de registro oplog. | |||||||||
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 almacenamiento de oplog compatible con S3habilita el cifrado del lado del servidor. | |||||||||
ssl | booleano | Opcional | Bandera que indica si esta tienda de registro de operaciones de almacenamiento 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 oplog compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el bucket de almacenamiento compatible con S3. | |||||||||
writeConcern | string | Opcional | Nivel de confirmación de escritura (write concern) usado para este almacén de oplog. 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 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 | |||||||||
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 muestra si el nombre de usuario y la contraseña de este almacén oplog de almacenamiento compatible con S3fueron cifrado utilizando credentialstool. | |||||||||
ID | string | Nombre que identifica de manera única esta tienda oplog de almacenamiento compatible con S3. | |||||||||
etiquetas | Arreglo de cadenas | Arreglo de etiquetas para gestionar a qué tareas de copia de seguridad Ops Manager puede asignar a los almacenes de oplog compatibles con S3. | |||||||||
enlaces | objeto arreglo | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los | |||||||||
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. | |||||||||
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 S3que aloja el almacén de registro de operaciones 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 se incluyó al crear o actualizar este almacenamiento de oplogs compatible con S3. | |||||||||
sseEnabled | booleano | Bandera que indica si este almacenamiento de oplog compatible con S3habilita el cifrado del lado del servidor. | |||||||||
ssl | booleano | Bandera que indica si esta tienda de registro de operaciones de almacenamiento 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 oplog compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el bucket de almacenamiento compatible con S3. | |||||||||
writeConcern | string | Nivel de confirmación de escritura (write concern) usado para este almacén de oplog. 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
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "awsAccessKey": "access", 9 "awsSecretKey": "secret", 10 "encryptedCredentials": false, 11 "id": "{S3-OPLOG-CONFIG-ID}", 12 "labels": [ 13 "l1", 14 "l2" 15 ], 16 "s3BucketEndpoint": "http://backup.example.com/oplog", 17 "s3BucketName": "oplog", 18 "uri": "mongodb://localhost:27017", 19 "ssl": true, 20 "writeConcern": "W2" 21 }'
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
1 { 2 "assignmentEnabled": true, 3 "awsAccessKey": "access", 4 "awsSecretKey": "secret", 5 "encryptedCredentials": false, 6 "id": "{S3-OPLOG-CONFIG-ID}", 7 "labels": [ 8 "l1", 9 "l2" 10 ], 11 "links": [ 12 { 13 "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs", 14 "rel": "self" 15 } 16 ], 17 "s3BucketEndpoint": "http://backup.example.com/oplog", 18 "s3BucketName": "oplog", 19 "uri": "mongodb://localhost:27017", 20 "ssl": true, 21 "writeConcern": "W2" 22 }