Página inicial do Docs

/ /

Configurações globais do aplicativo

Página inicial do Docs

/ /

Recursos

Configurações globais do aplicativo

Página inicial do Docs

Configurações globais do aplicativo

Obter configurações globais do aplicativo

Recupera as configurações globais do aplicativo para uma instalação do MongoDB Ops Manager.

Funções obrigatórias

Para chamar esse endpoint com êxito, sua chave de API deve ter a função Global Owner .

Solicitar

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

GET /admin/settings

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
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta está em um formato pretty-print.	`false`
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: `status`: Código de resposta HTTP `content`: Corpo de resposta esperado	`false`

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
`dbProperties`	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.
`defaultFileProperties`	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.
`instanceOverrides`	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.
`instanceDetails`	objeto	Detalhes da instância associados a substituições de banco de dados no nível da instância.
`secretProperties`	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 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

1 {
2   "dbProperties": {
3     "mms.centralUrl": "https://ops-manager.example.com",
4     "mms.https.CAFile": "/path/to/ca/file"
5   },
6   "defaultFileProperties": {
7     "mms.https.ClientCertificateMode": "none"
8   },
9   "instanceOverrides": {
10     "instance-1": {
11       "reCaptcha.enabled.registration": "false"
12     }
13   },
14   "instanceDetails": {
15     "instance-1": {
16       "om.instance.runtime.availableProcessors": 2
17     }
18   },
19   "secretProperties": [
20     "mms.smtp.password"
21   ]
22 }

Voltar

Configurações globais do aplicativo

Atualizar configurações

1	{
2	"dbProperties": {
3	"mms.centralUrl": "https://ops-manager.example.com",
4	"mms.https.CAFile": "/path/to/ca/file"
5	},
6	"defaultFileProperties": {
7	"mms.https.ClientCertificateMode": "none"
8	},
9	"instanceOverrides": {
10	"instance-1": {
11	"reCaptcha.enabled.registration": "false"
12	}
13	},
14	"instanceDetails": {
15	"instance-1": {
16	"om.instance.runtime.availableProcessors": 2
17	}
18	},
19	"secretProperties": [
20	"mms.smtp.password"
21	]
22	}