Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos da API de administração do Cloud Manager
/
Automação
/
Recurso de configuração de automação

Obter configurações de backup

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

Funções obrigatórias

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

Resource

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

GET /groups/{PROJECT-ID}/automationConfig/backupAgentConfig

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

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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 backup são diferentes das do MongoDB Agent. Configure esta opção ao atualizar de agentes legados para o MongoDB Agent.

Contexto
Tipo de Dados
string
string
string
inteiro
booleano
string
string
string
string
string
string
string
string
booleano
string
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 log de backup.
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 registros de backup.

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

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/backupAgentConfig?pretty=true" \
     --output currentBackupConfig.json

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  "logPath": "/var/log/mongodb-mms-automation/backup-agent.log",
3  "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\backup-agent.log",
4  "logRotate": {
5    "sizeThresholdMB": 1000.0,
6    "timeThresholdHrs": 24
7  },
8  "username": "mms-automation"
9}

Voltar

Atualizar versões do agente

Próximo

Atualizar configurações de backup