Docs Home

/ /

Bóveda de llaves

Docs Home

/ /

Administración de copias de seguridad

Bóveda de llaves

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Bóveda de llaves

Obtenga una configuración de Key Vault por ID

Recupera la configuración de una bóveda de claves.

Roles necesarios

Puede llamar a este endpoint con éxito con cualquiera de los siguientes roles asignados:

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

Resource

GET /keyVault/{KEY-VAULT-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
ID DE LA BÓVEDA DE CLAVES	string	Identificador único de la configuración del almacén de claves que se va a recuperar.

Parámetros de Solicitud Query

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 está 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: `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
ID	string	Identificador único que genera Ops Manager para esta configuración de almacén de claves. Utilice este valor como `vaultId` cuando configure un almacén de instantáneas de almacenamiento compatible con S3para que utilice este almacén de claves.
nombre amigable	string	Etiqueta legible para humanos que identifica esta configuración clave de la bóveda.
tipo	string	Tipo de proveedor de bóveda de claves. Ops Manager devuelve `HASHI_CORP`, que representa HashiCorp Vault.
URL	string	Dirección del servidor HashiCorp Vault al que se conecta Ops Manager.
auth	Objeto	Detalles de autenticación que utiliza Ops Manager para conectarse a HashiCorp Vault.
mecanismo de autorización	string	Método de autenticación que utiliza Ops Manager para conectarse a HashiCorp Vault. Ops Manager devuelve uno de los siguientes valores: `TOKEN` `JWT`
secreto de autenticación	string	Credencial que Ops Manager utiliza para autenticarse en HashiCorp Vault. Ops Manager cifra este valor en reposo y devuelve `[REDACTED]` en lugar del valor almacenado.
Reclamaciones de autorización de JWT	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` `JWT`es.
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 las URLse explican en la Especificación de enlace 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/{KEY-VAULT-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

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

Volver

Bóveda de llaves

Obtener todo