Observação
Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu grupo. Para grupos existentes, o ID do grupo/ ID do projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.
Resource
PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotScheduleParâmetros da solicitação
Parâmetros do caminho da solicitação
Parâmetro | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Obrigatório | Identificador único do projeto que contém o cluster com o agendamento de snapshot que você deseja atualizar. |
| string | Obrigatório | Identificador exclusivo 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 que indica se o corpo da resposta deve estar em um formato prettyprint. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de 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 da solicitação
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
| 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 IMPORTANTE: Você pode usar checkpoints para clusters que executam o MongoDB com |
| string | Opcional | Identificador único do cluster ao qual esta configuração de backup se aplica. |
| número | Opcional | Número de dias para manter snapshots diários. Você pode definir um valor entre Definir |
| 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. |
| string | Opcional | Identificador único do projeto que possui a configuração da cópia de segurança. |
| Array de objetos | Opcional | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
| número | Opcional | Número de meses para manter snapshots mensais. Você pode definir um valor entre Definir |
| número | Opcional | Número de horas entre snapshots. Você pode definir um valor de |
| número | Opcional | Número de dias para manter snapshots recentes. Você pode definir um valor entre |
| número | Opcional | Número de semanas para manter snapshots semanais. Você pode definir um valor entre Definir |
Resposta
Nome | Tipo | Descrição |
|---|---|---|
| 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 IMPORTANTE: Você pode usar checkpoints para clusters que executam o MongoDB com |
| string | Identificador único do cluster ao qual esta configuração de backup se aplica. |
| número | Número de dias para manter snapshots diários. O Cloud Manager pode retornar valores entre Definir |
| 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. |
| string | Identificador único do projeto que possui a configuração da cópia de segurança. |
| Array de objetos | Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays |
| número | Número de meses para manter snapshots mensais. O Cloud Manager pode retornar valores entre Definir |
| 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. |
| número | Número de horas entre snapshots. O Cloud Manager pode retornar valores de |
| número | Número de dias para manter snapshots recentes. O Cloud Manager pode retornar valores entre |
| número | Número de semanas para manter snapshots semanais. O Cloud Manager pode retornar valores entre Definir |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \ --data ' { "fullIncrementalDayOfWeek":"TUESDAY", "snapshotIntervalHours": 8, "dailySnapshotRetentionDays": 15, "monthlySnapshotRetentionMonths": 6 }'Exemplo de resposta
Cabeçalho de resposta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "clusterId" : "{CLUSTER-ID}", "dailySnapshotRetentionDays" : 15, "fullIncrementalDayOfWeek":"TUESDAY", "groupId" : "{PROJECT-ID}", "links" : [], "monthlySnapshotRetentionMonths" : 6, "pointInTimeWindowHours": 24, "snapshotIntervalHours" : 8, "snapshotRetentionDays" : 2, "weeklySnapshotRetentionWeeks" : 4}