Obtenga una configuración de Blockstore por ID

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

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

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

Resource

GET /snapshot/mongoConfigs/{BLOCKSTORE-ID}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
BLOCKSTORE-ID	string	El nombre único que etiqueta esta configuración de almacén de bloques.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

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 envelope=true en la consulta.

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

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
asignación habilitada	booleano	Bandera que indica si a este almacén de bloques se le pueden asignar trabajos de respaldo.
encryptedCredentials	booleano	Bandera que indica si el nombre de usuario y la contraseña para este almacén de bloques se cifraron mediante el herramienta de credenciales.
ID.	string	El nombre único que etiqueta esta tienda de bloques.
Etiquetas	matriz de cadenas	Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué blockstores.
enlaces	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
factor de carga	Número	Un entero positivo distinto de cero que expresa la cantidad de trabajo de copia de seguridad que este almacén de instantáneas debe realizar en comparación con otro. Esta opción solo es necesaria si se utilizan más de un almacén de instantáneas. Para obtener más información sobre Load Factor,consulte Editar un almacén de bloques existente.
maxCapacityGB	Número	Opcional. Capacidad máxima disponible prevista del almacén de bloques para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. `maxCapacityGB` no impone ninguna limitación en el tamaño de la base de datos de respaldo.
uri	string	Una lista separada por comas de hosts en el `<hostname:port>` formato que se pueden usar para acceder a este almacén de bloques.
ssl	booleano	Bandera que indica si este almacén de bloques 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 bloques. Los valores aceptados para esta opción son: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` 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/snapshot/mongoConfigs/{BLOCKSTORE-ID}?pretty=true'

Ejemplo de respuesta

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}

Cuerpo de respuesta

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

Volver

Blockstore

Obtener todo