Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/ / / /

Atualizar a configuração de automação

Nesta página

  • Funções obrigatórias
  • Resource
  • Solicitar
  • parâmetros de caminho
  • parâmetros de query
  • Parâmetros do corpo
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Utilize o PUT para atualizar a configuração de automação de um projeto. Não use PATCH.

Para ver um tutorial sobre como atualizar uma configuração de automação, consulte Atualizar a configuração de automação.

Para fazer atualizações no MongoDB Agent diferentes de hostname, você deve fazer isso por meio de um endpoint diferente.

Quando você envia atualizações, o Cloud Manager faz modificações internas nos dados e, em seguida, salva sua nova versão da configuração.

Exemplo

O Cloud Manager pode adicionar um campo a cada versão do MongoDB da comunidade especificada para indicar de onde os agentes as baixam.

Os agentes MongoDB pesquisam continuamente o Cloud Manager em busca de alterações na configuração e procuram atualizações de configuração quando elas ocorrem. Os agentes então ajustam os estados de seus processos ao vivo para corresponder.

Aviso

Não há proteção na API de administração do Cloud 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":

Este recurso requer a função Project Automation Admin .

URL base: https://cloud.mongodb.com/api/public/v1.0

PUT /groups/{PROJECT-ID}/automationConfig
Nome
Tipo
necessidade
Descrição
ID do projeto
string
Obrigatório
Identificador exclusivo do grupo que possui a configuração de automação.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
false
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:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado
false

Para revisar esses parâmetros, consulte Parâmetros de configuração de automação.

Para revisar esses parâmetros, consulte Parâmetros de configuração de automaçã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?pretty=true" \
--data-binary "@/Users/admin/updated-conf.json"
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}

Para revisar um exemplo dessa configuração, consulte Exemplo de configuração de automação.

Voltar

Obter a configuração da automação