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 la ruta de solicitud
Este punto final no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de consulta de solicitud
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato. |
|
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 Para los puntos finales que devuelven una lista de resultados, el objeto |
|
Solo asignable | booleano | Bandera que indica si a este almacén de sincronización se le pueden asignar nuevos trabajos de respaldo. |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en el
Sección |
| arreglo | La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web. |
| Número | Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado. |
results Documento incrustado
Cada resultado es un almacén de sincronización.
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | booleano | Bandera que indica si se pueden asignar trabajos de respaldo a este almacén de sincronización. |
encryptedCredentials | booleano | Bandera que indica si el nombre de usuario y la contraseña para este almacén de sincronización se cifraron mediante la herramienta de credenciales. |
ID. | string | El nombre único que etiqueta esta tienda de sincronización. |
Etiquetas | matriz de cadenas | Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de sincronización. |
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
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. |
tamaño usado | Número | La cantidad de capacidad de respaldo en MB que consumen las copias de seguridad existentes. |
writeConcern | string | La preocupación de escritura utilizada para este almacén de sincronización. Los valores aceptados para esta opción son:
Para obtener más información sobre los niveles de reconocimiento de escritura en MongoDB, consulte Preocupación de escritura. |
Ejemplo de solicitud
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'
Ejemplo de respuesta
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}
Cuerpo de respuesta
{ "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 }