Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que especifica si el cuerpo de la respuesta debe tener un formato legible.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API 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 una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

soloasignable

booleano

Opcional

Indica si se deben devolver solo los blockstores a los que puedas asignar nuevas tareas de copia de seguridad.

true

Parámetros del cuerpo de la solicitud

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

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de objetos result, una matriz de objetos link y un recuento del número total de objetos result recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	arreglo	El array incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

Cada resultado es un almacenamiento en bloques.

Nombre	Tipo	Descripción
assignmentEnabled	booleano	Indicador que especifica si a este almacén de bloques 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 almacenamiento en bloques se cifraron mediante la 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 URLse explican en la Especificación de enlaces web.
factor de carga	Número	Un número entero positivo distinto de cero que indica la cantidad de trabajo de copia de seguridad que debe realizar este almacén de instantáneas en comparación con otro. Esta opción solo es necesaria si se utiliza más de un almacén de instantáneas. Para obtener más información sobre Load Factor, consulte 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.
oidc	Objeto	Configuraciónde autenticación OIDC para este almacén. El objeto `oidc` contiene los siguientes campos: `enabled`: booleano. Indica si la autenticación OIDC está habilitada para este almacén. `method`: string. Uno de `callback`, `azure`, `gcp` o `k8s`. `tokenUri`: cadena. El punto final del token IdP. Presente solo cuando `method` es `callback`. `clientId`: cadena. El ID de cliente registrado con el IdP. `clientSecret`: string. MongoDB Ops Manager redacta este valor en la respuesta y no devuelve el secreto de cliente sin procesar. `scope`: cadena. El ámbito OAuth2 solicitado al IdP. Presente solo cuando `method` es `callback`. `tokenResource`: string. El público o identificador de recursos para el token de identidad de la carga de trabajo. Presente solo cuando `method` sea `azure` o `gcp`.
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 copias 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).

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/snapshot/mongoConfigs?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

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "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-CONFIG-ID}",
      "rel" : "self"
    }],
    "loadFactor" : 2,
    "maxCapacityGB" : 8,
    "uri" : "mongodb://localhost:27017",
    "ssl" : true,
    "usedSize" : 222,
    "writeConcern" : "W2"
  } ],
  "totalCount" : 1
}

Volver

Obtener por ID

Crear

Obtener todas las configuraciones de almacenamiento en bloques

Resource

Parámetros de ruta de solicitud

Parámetros de Solicitud Query