Recupera as configurações globais do aplicativo para uma instalação do MongoDB Ops Manager.
Funções obrigatórias
Para chamar com êxito este ponto de extremidade, sua chave API deve ter a função Global Owner.
Solicitar
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /admin/settingsParâ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 |
|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve 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, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Campo | Tipo | Descrição |
|---|---|---|
| objeto | Pares de chave-valor de configurações globais do aplicativo armazenados no banco de dados. O MongoDB Ops Manager não retorna configurações secretas em texto simples. |
| objeto | Pares chave-valor dos arquivos de configuração padrão agrupados com o MongoDB Ops Manager. Essas configurações diferem do arquivo de substituição de configuração no nível da instância. |
| objeto | Configurações de substituição do banco de dados por instância. Você pode ler, mas não atualizar, essas configurações por meio da API pública. |
| objeto | Detalhes da instância associados a substituições de banco de dados no nível da instância. |
| array de strings | Nomes de configurações que o MongoDB Ops Manager armazena como valores criptografados no banco de dados. O conteúdo desta lista pode mudar em versões futuras. |
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/settings?pretty=true"Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "dbProperties": { "mms.centralUrl": "https://ops-manager.example.com", "mms.https.CAFile": "/path/to/ca/file" }, "defaultFileProperties": { "mms.https.ClientCertificateMode": "none" }, "instanceOverrides": { "instance-1": { "reCaptcha.enabled.registration": "false" } }, "instanceDetails": { "instance-1": { "om.instance.runtime.availableProcessors": 2 } }, "secretProperties": [ "mms.smtp.password" ]}