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`

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 una configuración de almacén de claves.

Nombre	Tipo	Descripción
ID	string	Identificador único que MongoDB Ops Manager genera para esta configuración de key vault. Utilice este valor como `vaultId` cuando configure un almacenamiento de snapshot compatible con S3para usar este key vault.
friendlyName	string	Etiqueta legible por humanos que identifica esta configuración de bóveda de claves.
tipo	string	Tipo de proveedor de Key Vault. MongoDB Ops Manager devuelve `HASHI_CORP`, que representa HashiCorp Vault.
URL	string	Dirección del servidor de HashiCorp Vault al que se conecta MongoDB Ops Manager.
auth	Objeto	Detalles de autenticación que MongoDB Ops Manager utiliza para conectarse a HashiCorp Vault.
auth.mechanism	string	Método de autenticación que utiliza Ops Manager para conectarse a HashiCorp Vault. MongoDB Ops Manager devuelve uno de los siguientes valores: `TOKEN` `JWT`
auth.secret	string	Credenciales que MongoDB Ops Manager utiliza para autenticarse en HashiCorp Vault. MongoDB Ops Manager cifra este valor en reposo y devuelve `[REDACTED]` en lugar del valor almacenado.
auth.jwtClaims	Objeto	Reclamaciones que Ops Manager envía cuando solicita un inicio de sesión JWT a HashiCorp Vault. Ops Manager devuelve este objeto solo cuando `auth.mechanism` es `JWT`.
cerfiticados personalizados	arreglo	Lista de certificados de Autoridad de Certificación personalizados que Ops Manager utiliza para la verificación TLS cuando se conecta al servidor HashiCorp Vault.
customCertificates[n].filename	string	Nombre que identifica el archivo PEM de la Autoridad de Certificación.
customCertificates[n].certString	string	Contenido del archivo PEM de la Autoridad de Certificación. Ops Manager devuelve `[REDACTED]` en lugar del valor almacenado.
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.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?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": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "id": "{KEY-VAULT-ID}",
      "friendlyName": "myVault",
      "type": "HASHI_CORP",
      "url": "https://localhost:8200/",
      "auth": {
        "mechanism": "TOKEN",
        "secret": "[REDACTED]"
      },
      "links": [
        {
          "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}",
          "rel": "self"
        }
      ]
    }
  ],
  "totalCount": 1
}

Volver

Obtener por ID

Crear

Obtener todas las configuraciones de almacén de claves

Roles necesarios

Resource

Parámetros de ruta de solicitud

Parámetros de Solicitud Query