Configura un nuevo almacén de sincronización.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /sync/mongoConfigs
Parámetros de la 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 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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | booleano | Opcional. Indicador que indica si este almacén de sincronización puede ser asignado a tareas de copia de seguridad. |
encryptedCredentials | booleano | opcional. Indicador que muestra si el nombre de usuario y la contraseña de este almacén de sincronización estaban cifrados utilizando el herramienta de credenciales. |
ID | string | El nombre único que etiqueta esta tienda de sincronización. |
etiquetas | Arreglo de cadenas | Opcional. Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de sincronización. Si se establecen estas etiquetas, se limita qué tareas de copia de seguridad puede procesar este almacén de sincronización. Si se omite, este almacén de sincronización solo puede procesar tareas de copia de seguridad para proyectos que no usan etiquetas para filtrar sus tareas. |
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 | opcional. Bandera que indica si este almacén de sincronización solo acepta conexiones cifradas usando TLS. |
writeConcern | string | opcional. El nivel de confirmación de escritura (write concern) utilizado para este 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). |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | 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 etiqueta esta tienda 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 | One or more links to sub-resources or related resources. All |
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
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/sync/mongoConfigs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled" : true, 8 "encryptedCredentials" : false, 9 "id" : "{SYNCSTORE-CONFIG-ID}", 10 "labels" : [ "l1", "l2" ], 11 "maxCapacityGB" : 8, 12 "uri" : "mongodb://localhost:27017", 13 "ssl" : true, 14 "writeConcern" : "W2" 15 }'
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 "encryptedCredentials" : false, 4 "id" : "{SYNCSTORE-CONFIG-ID}", 5 "labels" : [ "l1", "l2" ], 6 "links" : [ { 7 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs", 8 "rel" : "self" 9 }], 10 "maxCapacityGB" : 8, 11 "uri" : "mongodb://localhost:27017", 12 "ssl" : true, 13 "usedSize" : 222, 14 "writeConcern" : "W2" 15 }