Atualizar a configuração de automação
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
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":
Funções obrigatórias
Este recurso requer a função Project Automation Admin
.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig
Solicitar
parâmetros de caminho
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
ID do projeto | string | Obrigatório | Identificador exclusivo do grupo 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 | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. | 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:
| false |
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?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.