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

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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 .

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
`content`	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 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	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`. Definir `dailySnapshotRetentionDays` como `0` desabilita esta regra.
`fullIncrementalDayOfWeek`	string	Opcional	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	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`. Definir `monthlySnapshotRetentionMonths` como `0` desabilita esta regra.
`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`. 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 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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/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

Snapshots

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/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	}'

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	}