Devolver una ventana de mantenimiento para un proyecto

OBTENER /api/atlas/v1.0/groups/{groupId}/maintenanceWindow

Devuelve el periodo de mantenimiento para el Proyecto especificado. MongoDB nube inicia esas actividades de mantenimiento cuando es necesario. No puedes cambiar tu periodo de mantenimiento hasta que se completen los esfuerzos de mantenimiento actuales. El procedimiento de mantenimiento que realiza MongoDB Cloud requiere al menos una elección de set de réplicas durante el periodo de mantenimiento por set de réplicas. El mantenimiento siempre comienza tan cerca de la hora programada como sea posible, pero las actualizaciones de clúster en curso o problemas imprevistos del sistema podrían retrasar la hora de inicio. Para usar este recurso, la cuenta de servicio solicitante o la clave de API debe tener el rol de propietario del proyecto.

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • autoDeferOnceEnabled booleano

      Bandera que indica si MongoDB Cloud debe aplazar todos los periodos de mantenimiento durante una semana después de que los habilites. Esta configuración controla la misma funcionalidad de aplazamiento automático subyacente que el endpoint /maintenanceWindow/autoDefer. Utilice este campo (para establecer un valor específico) o ese endpoint (para alternar el valor actual). Para la mayoría de los casos de uso, se prefiere este campo en la solicitud PATCH porque permite establecer un valor explícito en lugar de alternar.

    • día de la semana integer(int32) Requerido

      Entero basado en uno que representa el día de la semana en que comienza el periodo de mantenimiento.

      • 1: Domingo.
      • 2: lunes.
      • 3Martes.
      • 4: Miércoles.
      • 5: Jueves.
      • 6Viernes.
      • 7Sábado.

      El valor mínimo es 1, el valor máximo es 7.

    • hourOfDay integer(int32)

      Un número entero basado en cero que representa la hora del día a la que comienza el periodo de mantenimiento, según un reloj de 24 horas. Usa 0 para medianoche y 12 para mediodía.

      El valor mínimo es 0, el valor máximo es 23.

    • numberOfDeferrals integer(int32)

      Número de veces que el evento de mantenimiento actual de este proyecto se ha pospuesto.

    • protectedHours Objeto

      Define una ventana durante la cual no se comenzará el mantenimiento.

      Ocultar atributos protectedHours Mostrar atributos "protectedHours" Objeto
      • horaFinalDelDia integer(int32)

        Entero basado en cero que representa la hora final del día en la que no comenzará el mantenimiento.

        El valor mínimo es 0, el valor máximo es 23.

      • startHourOfDay integer(int32)

        Entero basado en cero que representa la hora inicial del día en el que no comenzará el mantenimiento.

        El valor mínimo es 0, el valor máximo es 23.

    • startASAP booleano

      Indicador que indica si MongoDB Cloud inicia el periodo de mantenimiento inmediatamente después de recibir esta solicitud. Para iniciar el periodo de mantenimiento inmediatamente para tu Proyecto, MongoDB Cloud debe tener el mantenimiento programado y debes establecer un periodo de mantenimiento. Este indicador se restablece a false después de que MongoDB Cloud finalice el mantenimiento.

    • timeZoneId string

      Identificador de la zona horaria actual de la ventana de mantenimiento. Solo se puede actualizar mediante la interfaz de configuración del proyecto.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 aplicación/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

OBTENER /api/atlas/v1.0/grupos/{groupId}/maintenanceWindow
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/maintenanceWindow' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "autoDeferOnceEnabled": true,
  "dayOfWeek": 42,
  "hourOfDay": 42,
  "numberOfDeferrals": 42,
  "protectedHours": {
    "endHourOfDay": 42,
    "startHourOfDay": 42
  },
  "startASAP": true,
  "timeZoneId": "string"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "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"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}