Atualizar configurações de monitoramento
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 .
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/monitoringAgentConfig
Solicitar
parâmetros de caminho
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
ID do projeto | string | Obrigatório | 24única -string de dígitos hexadecimais que identifica o projeto que possui a configuraçã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:
| false |
Parâmetros do corpo
Para alterar essas configurações com o MongoDB Agent, inclua um ou mais desses parâmetros no corpo da solicitação.
Parâmetro | Tipo | necessidade | Descrição | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configOverrides | objeto | Opcional | Lista de configurações do MongoDB Agent que você precisa alterar porque suas configurações de monitoramento são diferentes das do MongoDB Agent. Configure esta opção ao atualizar de agentes legados para o MongoDB Agent.
| ||||||||||||||||||||||||||||||
logPath | string | Opcional | Caminho de arquivo absoluto para o qual este MongoDB Agent grava seus registros. Se isso não for especificado, o registro gravará no erro padrão ( stderr) em sistemas baseados em UNIX e Linux e no evento em sistemas Windows. | ||||||||||||||||||||||||||||||
logRotate | objeto | Opcional | Limites após os quais esse MongoDB Agent gira o registro de monitoramento. | ||||||||||||||||||||||||||||||
logRotate .sizeThresholdMB | inteiro | Opcional | Tamanho máximo, em MB, de um arquivo de log antes que esse MongoDB Agent gire os registros. | ||||||||||||||||||||||||||||||
logRotate .timeDurationHrs | inteiro | Opcional | Número de horas após as quais esse MongoDB Agent gira o arquivo de log. | ||||||||||||||||||||||||||||||
nome de usuário | string | Opcional | Usuário do MongoDB no reconhecimento de data center que managed os logs de monitoramento. Se você usar a API para habilitar a autenticação para o MongoDB Agent, defina esse parâmetro como mms-automation ao executar esse endpoint. |
Resposta
Parâmetro | Tipo | necessidade | Descrição | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configOverrides | objeto | Opcional | Lista de configurações do MongoDB Agent que você precisa alterar porque suas configurações de monitoramento são diferentes das do MongoDB Agent. Configure esta opção ao atualizar de agentes legados para o MongoDB Agent.
| ||||||||||||||||||||||||||||||
logPath | string | Opcional | Caminho de arquivo absoluto para o qual este MongoDB Agent grava seus registros. Se isso não for especificado, o registro gravará no erro padrão ( stderr) em sistemas baseados em UNIX e Linux e no evento em sistemas Windows. | ||||||||||||||||||||||||||||||
logRotate | objeto | Opcional | Limites após os quais esse MongoDB Agent gira o registro de monitoramento. | ||||||||||||||||||||||||||||||
logRotate .sizeThresholdMB | inteiro | Opcional | Tamanho máximo, em MB, de um arquivo de log antes que esse MongoDB Agent gire os registros. | ||||||||||||||||||||||||||||||
logRotate .timeDurationHrs | inteiro | Opcional | Número de horas após as quais esse MongoDB Agent gira o arquivo de log. | ||||||||||||||||||||||||||||||
nome de usuário | string | Opcional | Usuário do MongoDB no reconhecimento de data center que managed os logs de monitoramento. Se você usar a API para habilitar a autenticação para o MongoDB Agent, defina esse parâmetro como mms-automation ao executar esse endpoint. |
Exemplo de solicitação
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig" 6 --data '{ 7 "configOverrides" : { 8 "mmsBaseUrl" : "http://new.example.org" 9 }, 10 "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log", 11 "logRotate": { 12 "sizeThresholdMB": 1000, 13 "timeThresholdHrs": 12 14 }, 15 "username": "mms-automation" 16 }'
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
Este endpoint retorna um objeto JSON vazio.