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

Obter o agendamento 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.

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

Resource

GET /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 obter.

CLUSTER-ID

string

Obrigatório

Identificador único do cluster cuja programação de snapshot você deseja obter.

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

content

Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

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

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 Cloud Manager pode retornar valores de 15, 30 ou 60.

IMPORTANTE: você pode utilizar checkpoints para clusters que executam MongoDB com Feature Compatibility Version de 4.0 ou anterior. Os checkpoints foram removidos das instâncias do MongoDB com FCV 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 Cloud Manager pode retornar valores entre 1 e 365, inclusive.

Definir dailySnapshotRetentionDays como 0 desabilita esta regra.

fullIncrementalDayOfWeek

string

Dia da semana em que o Cloud Manager tira um snapshot completo. Isso garante um backup completo recente. Cloud Manager define o valor padrão para um dia da semana aleatório.

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 Cloud Manager pode retornar valores entre 1 e 36, inclusive.

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. Não é possível alterar esse valor para um snapshot.

snapshotIntervalHours

número

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

snapshotRetentionDays

número

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

weeklySnapshotRetentionWeeks

número

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

Definir weeklySnapshotRetentionWeeks como 0 desabilita esta regra.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule"

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" : 7,
4  "groupId" : "{PROJECT-ID}",
5  "links" : [],
6  "monthlySnapshotRetentionMonths" : 13,
7  "pointInTimeWindowHours": 24,
8  "snapshotIntervalHours" : 6,
9  "snapshotRetentionDays" : 2,
10  "weeklySnapshotRetentionWeeks" : 4
11}

Voltar

Cronograma de snapshots

Próximo

Update