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. |
|
itemsPerPage | número | Opcional | Número de itens a serem devolvidos por página, até um máximo de 500. |
|
pretty | booleano | Opcional |
| |
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure Para endpoints que retornam uma lista de resultados, o objeto |
|
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 uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.
Nome | Tipo | Descrição |
|---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| 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. |
| 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 chave.
Nome | Tipo | Descrição |
|---|---|---|
id | string | Identificador exclusivo que o Ops Manager gera para essa configuração de cofre de chaves. Use esse valor como |
Amigável | string | Etiqueta legível por humanos que identifica esta configuração de cofre de chaves. |
type | string | Tipo de fornecedor de cofre de chaves. O Ops Manager retorna |
URL | string | Endereço do servidor do HashiCorp Vault ao qual o Ops Manager se conecta. |
auth | objeto | Detalhes de autenticação que o Ops Manager usa para se conectar ao HashiCorp Vault. |
auth.mecanismo | string | Método de autenticação que o gerente de operações usa para se conectar ao HashiCorp Vault. O Ops Manager retorna um dos seguintes valores:
|
auth.secret | string | Credenciais que o gerente de operações usa para autenticar no HashiCorp Vault. O Ops Manager criptografa esse valor em repouso e retorna |
auth.jwtClaims | objeto | Declarações que o gerente de operações envia quando solicita um login JWT do HashiCorp Vault. O Ops Manager retorna este objeto somente quando |
customCertificates | array | Lista de certificados de autoridade de certificação personalizados que o Ops Manager usa para verificação TLS quando se conecta 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 Ops Manager retorna |
links | array de objetos | Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays |
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
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
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 }