Atualizar um período de manutenção para um projeto
Atualiza o período de manutenção do projeto especificado. Atividades de manutenção urgentes, como patches de segurança, não podem aguardar o período escolhido. O MongoDB Cloud inicia essas atividades de manutenção quando necessário. Depois de agendar a manutenção para o cluster, você não poderá alterar o período de manutenção até que o trabalho de manutenção atual seja concluído. O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma eleição de conjunto de réplicas durante o período de manutenção por conjunto de réplicas. A manutenção sempre começa o mais próximo possível do horário agendado, mas atualizações do cluster em andamento ou problemas inesperados no sistema podem atrasar o horário de início. Atualizar o período de manutenção redefinirá quaisquer adiamentos de manutenção para este projeto. 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.
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})$
.
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
.
corpo, corpo
Obrigatório
Atualiza a janela de manutenção do projeto especificado.
-
Sinalizador que indica se o MongoDB Cloud deve adiar todas as janelas de manutenção por uma semana após sua ativação.
-
Um inteiro baseado que representa o dia da semana em que a janela de manutenção é iniciada.
1
: Domingo.2
: Segunda-feira.3
: Terça-feira.4
: Quarta-feira.5
: Quinta-feira.6
: Sexta-feira.7
: Sábado.
O valor mínimo é
1
, o valor máximo é7
. -
Número inteiro com base zero que representa a hora do dia em que a janela de manutenção começa, de acordo com um relógio de 24 horas. Use
0
para meia-noite e12
para meio-dia.O valor mínimo é
0
, o valor máximo é23
. -
Define a janela em que a manutenção não começará.
-
Sinalizador que indica se o MongoDB Cloud inicia a janela de manutenção imediatamente após o recebimento dessa solicitação. Para iniciar a janela de manutenção imediatamente para seu projeto, o MongoDB Cloud deve ter a manutenção agendada e você deve definir uma janela de manutenção. Esse sinalizador é redefinido para
false
após a conclusão da manutenção do MongoDB Cloud.
atlas api maintenanceWindows updateGroupMaintenanceWindow --help
import (
"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.UpdateGroupMaintenanceWindowApiParams{}
sdkResp, httpResp, err := client.MaintenanceWindowsApi.
UpdateGroupMaintenanceWindowWithParams(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}/maintenanceWindow" \
-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}/maintenanceWindow" \
-d '{ <Payload> }'
{
"autoDeferOnceEnabled": true,
"dayOfWeek": 42,
"hourOfDay": 42,
"protectedHours": {
"endHourOfDay": 42,
"startHourOfDay": 42
},
"startASAP": 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"
}