Aconfiguração de automação do de um projeto determina o estado do objetivo de seus processos e agentes do MongoDB . O MongoDB Agent cria a implantação de acordo com os objetivos especificados.
Uma configuração de automação pode conter informações confidenciais, como senhas e valores de chave. Este recurso permite atualizar a configuração de automação de um projeto sem atualizar nenhum campo que contenha informações confidenciais.
PUT As solicitações para o /groups/{PROJECT-ID}/automationConfig/noSecrets endpoint ignoram todos os campos na configuração de automação no corpo da solicitação que contenham informações confidenciais, deixando seus valores atuais inalterados e atualizando todos os outros campos. Para atualizar a configuração de automação completa, incluindo quaisquer informações confidenciais, use o endpoint /groups/{PROJECT-ID}/automationConfig.
Para atualizar a configuração:
Recupere a configuração atual.
Você pode usar o endpoint /groups/{PROJECT-ID}/automationConfig para obter a configuração completa ou usar o endpoint /groups/{PROJECT-ID}/automationConfig/noSecrets para obter a configuração com informações confidenciais editadas, como senhas ou valores de chave.
Faça alterações em uma cópia da configuração atual, alterando apenas os itens que você deseja modificados.
Substitua toda a configuração usando
PUTpela configuração atualizada no corpo da solicitação. Você devePUTusar. NãoPATCHuse.Quando você envia atualizações, o Ops Manager faz modificações internas nos dados e, em seguida, salva sua nova versão da configuração.
Observação
Alguns parâmetros não podem ser atualizados através do endpoint automationConfig . Para saber mais, consulte:
Para fazer atualizações no MongoDB Agent diferentes de hostname, você deve fazer isso por meio de um endpoint diferente.
Para ver um tutorial sobre como atualizar uma configuração de automação, consulte Atualizar a configuração de automação de um projeto.
Os MongoDB Agents pesquisam continuamente o Ops Manager em busca de alterações na configuração e obtêm atualizações de configuração quando elas ocorrem. Os agentes então ajustam os estados de seus processos ao vivo para corresponder.
Aviso
Fazer alterações na configuração de automação usando uma solicitação PUT pode causar tempo de inatividade do cluster. Teste suas alterações em ambientes inferiores antes de aplicá-las aos ambientes de produção.
Aviso
Não há proteção na API de administração do Ops Manager para evitar modificações simultâneas. Se dois administradores começarem com uma configuração baseada na versão atual, fizerem suas próprias modificações e, em seguida, enviarem suas modificações, a modificação posterior vencerá.
Aviso
Atualize o nome de usuário do agente antes de ativar a autenticação
A configuração de automação fornece o único meio para habilitar a autenticação em seus clusters utilizando aAPI . Para habilitar a autenticação, primeiro chame os seguintes endpoints com "username": "mms-automation":
Funções obrigatórias
Este recurso requer a função Project Automation Admin .
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig/noSecrets
Solicitar
parâmetros de caminho
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
ID do projeto | string | Obrigatório | Identificador exclusivo dogrupo que possui a configuração de automação. |
parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional |
| |||||||
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, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo
Para revisar esses parâmetros, consulte Parâmetros de configuração de automação.
Resposta
Para revisar esses parâmetros, consulte Parâmetros de configuração de automação.
Exemplo de solicitação
O seguinte substitui a configuração de automação pela configuração atualizada salva no /Users/admin/updated-conf.json. Para obter um exemplo de um documento de configuração atualizado, consulte Exemplo de configuração de automação.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/noSecrets?pretty=true" \ --data-binary "@/Users/admin/updated-conf.json"
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
Para revisar um exemplo dessa configuração, consulte Exemplo de configuração de automação.