Atualizar a configuração de rotação do registro de auditoria
Esse endpoint atualiza a configuração de rotação do registro de auditar do MongoDB Agent . Após a conclusão dessa solicitação, o MongoDB Ops 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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig/auditLogRotateConfig
Solicitar
parâmetros de caminho
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
ID do projeto | string | Obrigatório | Identificador exclusivo doprojeto 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. |
| ||||||
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:
|
|
Parâmetros do corpo
Observação
Se você passar um corpo de solicitação vazio, o MongoDB Ops Manager desabilitará a rotação do registro. Os corpos de solicitação preenchidos exigem pelo menos os campos sizeThresholdMB e timeThresholdHrs . MongoDB Ops Manager define qualquer outro campo do corpo da solicitação nulo ou não preenchido como padrão do sistema.
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
sizeThresholdMB | float | Opcional | Tamanho máximo em MB para um arquivo de log individual antes da rotação. OBSERVAÇÃO: esse parâmetro é necessário, a menos que você esteja passando um corpo de solicitação vazio para desativar a rotação do registro. |
TimeThresholdHrs | int | Opcional | Tempo máximo em horas para um arquivo de log individual antes da rotação. OBSERVAÇÃO: esse parâmetro é necessário, a menos que você esteja passando um corpo de solicitação vazio para desativar a rotação do registro. |
numUncompressed | int | Opcional | Número máximo de arquivos de log totais para deixar descompactados, incluindo o arquivo de log atual. O padrão é |
percentOfDiskspace | float | Opcional | Porcentagem máxima do espaço total em disco que todos os arquivos de log devem ocupar antes da exclusão. O padrão é |
numTotal | int | Opcional | Número total de arquivos de log. Se o número de arquivos de log no disco for maior que esse número, os arquivos mais antigos serão excluídos. Se um número não for especificado, o padrão será 0 e será determinado por outras configurações. |
Resposta
MongoDB Ops Manager retorna um objeto JSON vazio no evento de uma solicitação bem-sucedida.
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 PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/auditLogRotateConfig?pretty=true" \ 6 --data ' { 7 "sizeThresholdMB": 5005.5, 8 "timeThresholdHrs": 13, 9 "numUncompressed": 10, 10 "percentOfDiskspace": 0.1, 11 "numTotal": 15 12 }'
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
{ }