Recupera las configuraciones de todos los almacenes de sincronización.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /sync/mongoConfigs
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 |
|
soloasignable | booleano | Indica si a este almacén de sincronización 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 almacén de sincronización.
Nombre | Tipo | Descripción |
|---|---|---|
assignmentEnabled | booleano | Indicador que señala si a ese almacén de sincronización se le pueden asignar trabajos de copia de seguridad. |
encryptedCredentials | booleano | Indicador que señala si el nombre de usuario y la contraseña de este almacén de sincronización fueron cifrados mediante la herramienta de credenciales. |
ID | string | El nombre único que identifica este almacén de sincronización. |
etiquetas | Arreglo de cadenas | Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué almacenes de sincronización. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos |
maxCapacityGB | Número | Opcional. La capacidad máxima esperada disponible del almacén de sincronización para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. |
uri | string | Una lista separada por comas de hosts en el formato |
ssl | booleano | Bandera que indica si este almacén de sincronización solo acepta conexiones cifradas mediante TLS. |
usedSize | Número | La cantidad de capacidad de copia de seguridad en MB que consumen las copias de seguridad existentes. |
writeConcern | string | La nivel de confirmación de escritura (write concern) utilizada para esta almacén de sincronización. Los valores aceptados para esta opción son:
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' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?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/sync/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNCSTORE-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" } ], "totalCount" : 1 }