Obtener una configuración de almacén de sincronización por ID

Recupera la configuración de un almacén de sincronización.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

GET /sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
SYNC-STORE-CONFIG-ID	string	El identificador único que representa esta configuración de Oplog.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

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 `links` en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre las URLse explican en la Especificación de enlace web.
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. `maxCapacityGB` no aplica ninguna limitación al tamaño de la base de datos de respaldo.
uri	string	Una lista separada por comas de hosts en el formato `<hostname:port>` que se pueden usar para acceder a este almacén de sincronización.
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: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` 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/{SYNC-STORE-CONFIG-ID}?pretty=true'

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 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

HTTP/1.1 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

{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "id" : "{CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}