Atualizar o agendamento de backup em nuvem para um cluster
Atualiza o agendamento de backup em nuvem para um cluster dentro do projeto especificado. Esse agendamento define quando o MongoDB Cloud captura snapshots programados e por quanto tempo os armazena. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto. Versões obsoletas: v2-{2023-01-01}
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Etiqueta legível por humanos que identifica o cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
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 consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Atualiza o agendamento de backup em nuvem para um cluster dentro do projeto especificado.
Observação: no corpo da solicitação, forneça apenas os campos que você deseja atualizar.
-
Sinalizador que indica se o MongoDB Cloud exporta automaticamente os Snapshots de Backup em Nuvem para o Bucket de Exportação.
-
Lista que contém um documento para cada item de configuração de cópia na política de backup desejada.
Copie o item de configuração na política de backup desejada.
-
Lista que contém um documento para cada configuração de cópia excluída cujas cópias de backup você deseja excluir.
Configuração de cópia excluída cujas cópias de backup também precisam ser excluídas.
-
Política para exportar automaticamente snapshots de backup em nuvem.
-
Lista que contém um documento para cada item de configuração de retenção extra na política de backup desejada.
Item de configuração de retenção extra na política de backup desejada.
-
Regras definidas para este agendamento de backup.
Lista que contém um documento para cada item da política de backup na política de backup desejada.
Não mais do que
1elemento. -
Hora do dia no Horário Universal Coordenado (UTC) que representa quando o MongoDB Cloud faz o snapshot.
-
Minuto do referenceHourOfDay que representa quando a nuvem do MongoDB tira o snapshot.
-
Número de dias anteriores para os quais você pode restaurar com precisão do Continuous Cloud Backup. Você deve especificar um número inteiro positivo, diferente de zero. Esse parâmetro se aplica somente aos backups contínuos na nuvem.
-
Sinalizador que indica se as alterações de retenção na política de backup atualizada devem ser aplicadas aos snapshots que o MongoDB Cloud fez anteriormente.
-
Sinalizador que indica quando usar os nomes da organização e do projeto em vez dos UUIDs da organização e do projeto no caminho para os arquivos de metadados que o MongoDB Cloud faz upload para o seu Export Bucket.
atlas api cloudBackups updateGroupClusterBackupSchedule --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateGroupClusterBackupScheduleApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
UpdateGroupClusterBackupScheduleWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \
-d '{ <Payload> }'{
"autoExportEnabled": true,
"copySettings": [
{
"cloudProvider": "AWS",
"frequencies": [
"HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"deleteCopiedBackups": [
{
"cloudProvider": "AWS",
"regionName": "string",
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [
{
"frequencyType": "HOURLY",
"retentionDays": 42
}
],
"policies": [
{
"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [
{
"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 42
}
]
}
],
"referenceHourOfDay": 42,
"referenceMinuteOfHour": 42,
"restoreWindowDays": 42,
"updateSnapshots": true,
"useOrgAndGroupNamesInExportPrefix": true
}{
"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [
{
"cloudProvider": "AWS",
"frequencies": [
"HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [
{
"frequencyType": "HOURLY",
"retentionDays": 42
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2025-05-04T09:42:00Z",
"policies": [
{
"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [
{
"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 42
}
]
}
],
"referenceHourOfDay": 42,
"referenceMinuteOfHour": 42,
"restoreWindowDays": 42,
"useOrgAndGroupNamesInExportPrefix": true
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}