Actualiza la ventana de mantenimiento del proyecto especificado. Las actividades de mantenimiento urgentes, como la aplicación de parches de seguridad, no pueden esperar a la ventana seleccionada. MongoDB Cloud inicia dichas actividades de mantenimiento cuando es necesario. Después de programar el mantenimiento del clúster, no se puede cambiar la ventana de mantenimiento hasta que finalicen las tareas de mantenimiento actuales. El procedimiento de mantenimiento que realiza MongoDB Cloud requiere al menos una elección de conjunto de réplicas durante la ventana de mantenimiento por conjunto de réplicas. El mantenimiento siempre comienza lo más cerca posible de la hora programada, pero las actualizaciones del clúster en curso o problemas inesperados del sistema podrían retrasar la hora de inicio. Actualizar la ventana de mantenimiento restablecerá cualquier aplazamiento de mantenimiento para este proyecto. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false.
Cuerpo
Requerido
Actualiza el periodo de mantenimiento para el proyecto especificado.
-
Indicador que indica si MongoDB Cloud debe aplazar todas las ventanas de mantenimiento durante una semana después de habilitarlas. Esta configuración controla la misma función subyacente de aplazamiento automático que el punto de conexión
/maintenanceWindow/autoDefer. Utilice este campo (para establecer un valor específico) o ese punto de conexión (para alternar el valor actual). En la mayoría de los casos, se prefiere este campo en la solicitud PATCH, ya que permite establecer un valor explícito en lugar de alternarlo. -
Entero basado en uno que representa el día de la semana en que comienza el periodo de mantenimiento.
1: Domingo.2: Lunes.3: Martes.4: Miércoles.5: Jueves.6: Viernes.7: Sábado.
El valor mínimo es
1, el valor máximo es7. -
Entero de base cero que representa la hora del día en que comienza la ventana de mantenimiento según un reloj de 24horas. Use
0para medianoche y12para mediodía.El valor mínimo es
0, el valor máximo es23. -
Define una ventana en la que no comenzará el mantenimiento.
-
Marca que indica si MongoDB Cloud inicia la ventana de mantenimiento inmediatamente al recibir esta solicitud. Para que la ventana de mantenimiento de su proyecto comience inmediatamente, MongoDB Cloud debe tener el mantenimiento programado y usted debe establecer una ventana de mantenimiento. Esta marca se restablece a
falsedespués de que MongoDB Cloud complete el mantenimiento.
atlas api maintenanceWindows updateMaintenanceWindow --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231001001/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.2023-10-01+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.2023-10-01+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"
}