Página inicial do Docs

/ /

Key Vault

Página inicial do Docs

/ /

Administração de backup

Key Vault

Página inicial do Docs

Administração de backup

Key Vault

Obter todas as configurações do Key Vault

Recupera as configurações de todos os cofres de chaves.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com qualquer um dos seguintes roles atribuídos:

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

Resource

GET /keyVault

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um formato de impressão bonita.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na query. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Ops Manager adiciona o campo `status` ao corpo da resposta.	`false`

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

documento de resposta

O documento JSON de resposta inclui um array de objetos result, um array de objetos link e uma contagem do número total de objetos result recuperados.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção `results` Documento incorporado.
`links`	array	A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
`totalCount`	número	Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

`results` documento incorporado

Cada resultado é uma configuração de cofre de chaves.

Nome	Tipo	Descrição
id	string	Identificador exclusivo que o MongoDB Ops Manager gera para esta configuração de cofre de chaves. Use este valor como o `vaultId` ao configurar um armazenamento de snapshots compatível com S3para usar este cofre de chaves.
Nome amigável	string	etiqueta legível por humanos que identifica esta configuração do cofre de chaves.
type	string	Tipo de provedor de cofre de chaves. O Ops Manager retorna `HASHI_CORP`, que representa o HashiCorp Vault.
URL	string	Endereço do servidor HashiCorp Vault ao qual o MongoDB Ops Manager se conecta.
auth	objeto	Detalhes de autenticação que o MongoDB Ops Manager usa para se conectar ao HashiCorp Vault.
auth.mechanism	string	Método de autenticação que o MongoDB Ops Manager usa para se conectar ao HashiCorp Vault. O MongoDB Ops Manager retorna um dos seguintes valores: `TOKEN` `JWT`
auth.secret	string	Credenciais que o MongoDB Ops Manager usa para autenticar no HashiCorp Vault. O MongoDB Ops Manager criptografa esse valor em repouso e retorna `[REDACTED]` em vez do valor armazenado.
auth.jwtClaims	objeto	Reivindicações que o MongoDB Ops Manager envia quando solicita um login de JSON web token do HashiCorp Vault. O MongoDB Ops Manager retorna este objeto somente quando `auth.mechanism` é `JWT`.
customCertificates	array	Lista de certificados de autoridade de certificação personalizados que o MongoDB Ops Manager usa para verificação de TLS ao se conectar ao servidor HashiCorp Vault.
customCertificates[n].filename	string	Nome que identifica o arquivo PEM da Autoridade de certificação.
customCertificates[n].certString	string	Conteúdo do arquivo PEM da autoridade de certificação. O MongoDB Ops Manager retorna `[REDACTED]` em vez do valor armazenado.
links	array de objetos	Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.

Exemplo de solicitação

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'

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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

Voltar

Obter por ID

criar

Obter todas as configurações do Key Vault

Funções obrigatórias

Resource

Parâmetros do caminho da solicitação

Solicitar parâmetros de query

Parâmetros do corpo da solicitação

Resposta

documento de resposta

results documento incorporado

Exemplo de solicitação

Exemplo de resposta

Cabeçalho de resposta

Corpo de resposta

`results` documento incorporado