Recupera las configuraciones de todos los almacenes oplog s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /oplog/s3Configs
Parámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en una 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 remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
backupJobsEnabledOnly | booleano | Opcional | Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en |
|
soloasignable | booleano | Indicador de si a esta S3 oplog tienda se le pueden asignar nuevas tareas de copia de seguridad. |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en el
Sección |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada resultado es un almacenar de oplog s3.
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
curl --user '{USERNAME}:{APIKEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true'
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
{ "links" : [ { "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled": true, "awsAccessKey": "access", "awsSecretKey": "secret", "encryptedCredentials": false, "id": "id", "labels": [ "l1", "l2" ], "links": [ { "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-ID}", "rel": "self" } ], "s3BucketEndpoint": "http://backup.example.com/oplog", "s3BucketName": "oplog", "uri": "mongodb://localhost:27017", "ssl": true, "writeConcern": "W2" } ], "totalCount" : 1 }