Atualizar versões do agente

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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 .

Esse endpoint atualiza o MongoDB Agent e as ferramentas para as versões mais recentes disponíveis no momento da solicitação:

Após a conclusão dessa solicitação, o Cloud Manager modifica a configuração do agente e salva a versão atualizada.

Funções obrigatórias

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

Resource

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

POST /groups/{PROJECT-ID}/automationConfig/updateAgentVersions

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 da 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

Parâmetros do corpo

Nome	Tipo	necessidade	Descrição
automationAgentVersion	string	Opcional	Versão para a qual você deseja atualizar o MongoDB Agent.
biConnectorVersion	string	Opcional	Versão para a qual você deseja atualizar o BI Connector.
mongoDbToolsVersion	string	Opcional	Versão para a qual você deseja atualizar as ferramentas do banco deMongoDB database

Resposta

Parâmetro	Tipo	Descrição
automationAgentVersion	string	Versão do MongoDB Agent no projeto especificado.
backupAgentVersion	string	Versão do agente de backup no projeto especificado. O Cloud Manager removeu o agente de backup, portanto, este parâmetro deve retornar nulo.
biConnectorVersion	string	Versão do MongoDB connector para BI no projeto especificado.
mongoDbToolsVersion	string	Versão do Database Tools do MongoDB database no projeto especificado.
MonitoringAgentVersion	string	Versão do agente de monitoramento no projeto especificado. O Cloud Manager removeu o agente de monitoramento, portanto, este parâmetro deve retornar nulo.

Exemplo de solicitação

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/updateAgentVersions?pretty=true" \
6      --data '{
7        "automationAgentVersion": "11.11.0.7355"
8      }'

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   "automationAgentVersion": "11.11.0.7355",
3   "backupAgentVersion" : null,
4   "biConnectorVersion" : "2.14.0",
5   "mongoDbToolsVersion" : null,
6   "monitoringAgentVersion" : null
7 }

Voltar

Exemplo de configuração de automação

Obter configurações de backup

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/updateAgentVersions?pretty=true" \
6	--data '{
7	"automationAgentVersion": "11.11.0.7355"
8	}'

1	{
2	"automationAgentVersion": "11.11.0.7355",
3	"backupAgentVersion" : null,
4	"biConnectorVersion" : "2.14.0",
5	"mongoDbToolsVersion" : null,
6	"monitoringAgentVersion" : null
7	}