/ /

Recursos

Configurações globais do aplicativo

Página inicial do Docs

Configurações globais do aplicativo

Atualizar as configurações globais do aplicativo

Atualiza as configurações globais do aplicativo para uma instalação do MongoDB Ops Manager. Inclua apenas as configurações que você deseja alterar. O MongoDB Ops Manager deixa todas as outras configurações inalteradas.

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

PATCH /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

Campo	Tipo	necessidade	Descrição
`dbProperties`	objeto	Obrigatório	Pares chave-valor de configurações globais do aplicativo para atualizar ou adicionar. As configurações não incluídas na solicitação permanecem inalteradas. Para remover uma configuração, defina seu valor para `null`.

Importante

O MongoDB Ops Manager rejeita qualquer solicitação que inclua mms.app.upgradeMode, independentemente do valor. Essas solicitações retornam um erro 400 com o código de erro INVALID_SETTINGS_EXCEPTION.

A validação é executada em relação ao conjunto mesclado de configurações existentes e enviadas, e não apenas às propriedades enviadas. Uma solicitação pode falhar em um campo que você não incluiu se esse campo for uma dependência de uma configuração que você enviou e ainda não estiver configurado. Por exemplo, o envio de {"mms.emailDaoClass": "SIMPLE_MAILER"} falha com detail: "mms.mail.hostname must not be blank" se mms.mail.hostname não tiver nenhum valor existente.

Resposta

Campo	Tipo	Descrição
`restartRequired`	booleano	Indica se você deve reiniciar o Ops Manager para que as configurações atualizadas tenham efeito.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true" \
     --data '{
       "dbProperties": {
         "mms.centralUrl": "https://ops-manager.example.com"
       }
     }'

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   "restartRequired": false
3 }

Voltar

Obter configurações

Administração de backup