Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Backup e restauração
/
Cronograma de snapshots

Atualizar a programação de snapshots

Nesta página

  • Resource
  • Parâmetros da solicitação
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

Resource

PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Parâmetro
Tipo
necessidade
Descrição

PROJECT-ID

string

Obrigatório

Identificador único do projeto que contém o cluster com o agendamento de snapshot que você deseja atualizar.

CLUSTER-ID

string

Obrigatório

Identificador único do cluster cujo agendamento de snapshot você deseja atualizar.

Solicitar 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

envelope

Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Nome
Tipo
necessidade
Descrição

clusterCheckpointIntervalMin

número

Opcional

Número de minutos entre checkpoint sucessivos de clusters. Isso se aplica apenas a clusters fragmentados. Este número determina a granularidade das restaurações ponto-in-time para clusters fragmentados. Você pode definir um valor de 15, 30 ou 60.

Importante

Você pode usar checkpoints em clusters que executam o MongoDB com feature compatibility version do 4.0 ou anterior. Os pontos de controle foram removidos das instâncias do MongoDB com FCV de 4.2 ou posterior.

clusterId

string

Opcional

Identificador único do cluster ao qual esta configuração de backup se aplica.

dailySnapshotRetentionDays

número

Opcional

Número de dias para manter snapshots diários. Você pode definir um valor entre 1 e 365.

Observação

Definir dailySnapshotRetentionDays como 0 desabilita esta regra.

fullIncrementalDayOfWeek

string

Opcional

Dia da semana em que o Ops Manager tira um snapshot completo. Isso garante um backup completo recente. O Ops Manager define o valor-padrão como SUNDAY.

groupId

string

Opcional

Identificador único do projeto que possui a configuração da cópia de segurança.

links

array de objetos

Opcional

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

monthlySnapshotRetentionMonths

número

Opcional

Número de meses para manter snapshots mensais. Você pode definir um valor entre 1 e 36.

Observação

Definir monthlySnapshotRetentionMonths como 0 desabilita esta regra.

pointInTimeWindowHours

número

Opcional

Número de horas no passado para as quais um snapshot de ponto no tempo pode ser criado.

referenceHourOfDay

número

Opcional

Hora do dia para agendar snapshots usando um relógio em formato 24 horas. Você pode definir um valor entre 0 e 23.

referenceMinuteOfHour

número

Opcional

Minuto da hora para agendar snapshots. Você pode definir um valor entre 0 e 59.

referenceTimeZoneOffset

string

Opcional

O deslocamento de fuso horário ISO- onde8601 MongoDB Ops Manager reside o host do . Para evitar problemas com o horário de verão, use UTC. O padrão é +0000, que equivale a UTC. Z também é um valor suportado e equivalente a UTC.

O Ops Manager converte qualquer deslocamento diferente de +0000 para +0000 antes de armazená-lo e ajusta o valor referenceHourOfDay acordo.

Exemplo

Você passa uma solicitação com referenceHourOfDay de 5 e referenceTimeZoneOffset de "+0200". |onprem| stores a ``referenceHourOfDay de 3 e referenceTimeZoneOffset de "+0000".

snapshotIntervalHours

número

Opcional

Número de horas entre snapshots. Você pode definir um valor de 6, 8, 12 ou 24.

snapshotRetentionDays

número

Opcional

Número de dias para manter snapshots recentes. Você pode definir um valor entre 2 e 5.

weeklySnapshotRetentionWeeks

número

Opcional

Número de semanas para manter snapshots semanais. Você pode definir um valor entre 1 e 52.

Observação

Definir weeklySnapshotRetentionWeeks como 0 desabilita esta regra.

Resposta

Nome
Tipo
Descrição

clusterCheckpointIntervalMin

número

Número de minutos entre checkpoint sucessivos de clusters. Isso se aplica apenas a clusters fragmentados. Este número determina a granularidade das restaurações ponto-in-time para clusters fragmentados. O Ops Manager pode retornar valores de 15, 30 ou 60.

Importante

Você pode usar checkpoints em clusters que executam o MongoDB com feature compatibility version do 4.0 ou anterior. Os pontos de controle foram removidos das instâncias do MongoDB com FCV de 4.2 ou posterior.

clusterId

string

Identificador único do cluster ao qual esta configuração de backup se aplica.

dailySnapshotRetentionDays

número

Número de dias para manter snapshots diários. O Ops Manager pode retornar valores entre 1 e 365, inclusive.

Observação

Definir dailySnapshotRetentionDays como 0 desabilita esta regra.

fullIncrementalDayOfWeek

string

Dia da semana em que o Ops Manager tira um snapshot completo. Isso garante um backup completo recente. O Ops Manager define o valor-padrão como SUNDAY.

groupId

string

Identificador único do projeto que possui a configuração da cópia de segurança.

links

array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

monthlySnapshotRetentionMonths

número

Número de meses para manter snapshots mensais. O Ops Manager pode retornar valores entre 1 e 36, inclusive.

Observação

Definir monthlySnapshotRetentionMonths como 0 desabilita esta regra.

pointInTimeWindowHours

número

Número de horas no passado para as quais um snapshot de ponto no tempo pode ser criado.

referenceHourOfDay

número

Hora do dia para agendar snapshots usando um relógio em formato 24 horas. O Ops Manager pode retornar valores entre 0 e 23, inclusive.

referenceMinuteOfHour

número

Minuto da hora para agendar snapshots. O Ops Manager pode retornar valores entre 0 e 59, inclusive.

referenceTimeZoneOffset

string

O deslocamento de fuso horário ISO- onde8601 MongoDB Ops Manager reside o host do . Para evitar problemas com o horário de verão, use UTC. O padrão é +0000, que equivale a UTC. Z também é um valor suportado e equivalente a UTC.

O Ops Manager converte qualquer deslocamento diferente de +0000 para +0000 antes de armazená-lo e ajusta o valor referenceHourOfDay acordo.

Exemplo

Você passa uma solicitação com referenceHourOfDay de 5 e referenceTimeZoneOffset de "+0200". |onprem| stores a ``referenceHourOfDay de 3 e referenceTimeZoneOffset de "+0000".

snapshotIntervalHours

número

Número de horas entre snapshots. O Ops Manager pode retornar valores de 6 , 8 , 12 ou 24 .

snapshotRetentionDays

número

Número de dias para manter snapshots recentes. O Ops Manager pode retornar valores entre 2 e 5, inclusive.

weeklySnapshotRetentionWeeks

número

Número de semanas para manter snapshots semanais. O Ops Manager pode retornar valores entre 1 e 52, inclusive.

Observação

Definir weeklySnapshotRetentionWeeks como 0 desabilita esta regra.

Exemplo de solicitação

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \
6     --data '
7       {
8         "fullIncrementalDayOfWeek":"TUESDAY"
9         "snapshotIntervalHours": 8,
10         "dailySnapshotRetentionDays": 15,
11         "monthlySnapshotRetentionMonths": 6
12       }'

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  "clusterId" : "{CLUSTER-ID}",
3  "dailySnapshotRetentionDays" : 15,
4  "fullIncrementalDayOfWeek":"TUESDAY",
5  "groupId" : "{PROJECT-ID}",
6  "links" : [],
7  "monthlySnapshotRetentionMonths" : 6,
8  "pointInTimeWindowHours": 24,
9  "snapshotIntervalHours" : 8,
10  "snapshotRetentionDays" : 2,
11  "weeklySnapshotRetentionWeeks" : 4
12}

Voltar

Obter agendamento

Próximo

Snapshots