Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

Obtener una configuración de almacenamiento en bloques por ID

Recupera la configuración de un almacenamiento en bloques.

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

GET /snapshot/mongoConfigs/{BLOCKSTORE-ID}
Nombre
Tipo
Descripción

BLOCKSTORE-ID

string

El nombre único que etiqueta esta configuración de almacenamiento en bloques.

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.

false

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 solucionar este problema, configure 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

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

Nombre
Tipo
Descripción

assignmentEnabled

booleano

Indicador que señala si este almacenamiento en bloques puede asignarse a tareas de copia de seguridad.

encryptedCredentials

booleano

Indicador que señala si el nombre de usuario y la contraseña de este almacenamiento en bloques fueron cifrados usando el credentialstool.

ID

string

El nombre único que identifica este almacenamiento en bloques.

etiquetas

Arreglo de cadenas

Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué blockstores.

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.

factor de carga

Número

Un entero positivo y diferente de cero que expresa cuánto trabajo de copia de seguridad debe realizar este almacenamiento de snapshot en comparación con otro almacenamiento de snapshot. Esta opción solo es necesaria si se utiliza más de un almacenamiento de snapshot.

Para aprender más acerca de Load Factor, consulta Editar un almacenamiento en bloques existente.

maxCapacityGB

Número

opcional. La capacidad máxima disponible esperada del almacenamiento en bloques para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. maxCapacityGB no aplica ningún límite en el 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 utilizar para acceder a este almacenamiento en bloques.

ssl

booleano

Indicador de si este almacenamiento en bloques sólo acepta conexiones cifradas utilizando TLS.

usedSize

Número

La cantidad de capacidad de copia de seguridad en MB que consumen las copias de seguridad existentes.

writeConcern

string

El nivel de confirmación de escritura (write concern) utilizado para este almacenamiento en bloques.

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).

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'
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}
{
"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

En esta página