Actualizar cronograma de snapshots para un clúster Obsoleto

PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/snapshotSchedule

Actualiza el cronograma de snapshots para un clúster en el Proyecto especificado.

A partir del 23 de marzo de 2020, todos los nuevos clústeres solo podrán utilizar Copias de Seguridad en la Nube. Cuando actualices a 4.2, tu sistema de copia de seguridad se actualizará a copia de seguridad en la nube si está configurado actualmente como respaldo heredado. Después de esta actualización, todos tus snapshots de respaldo heredados siguen estando disponibles. Expiran con el tiempo de acuerdo con su política de retención. La política de copia de seguridad se restablece al cronograma predeterminado. Si tenía una política de copia de seguridad personalizada implementada con respaldos heredados, debe volver a crearla con el procedimiento descrito en la documentación de copias de seguridad en la nube.

Requisitos del rol
  • Propietario del proyecto
Documentación de copias de seguridad en la nube

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})$.

  • Nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica el clúster con la snapshot que deseas devolver.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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.

    pretty-print
application/json

Cuerpo Requerido

Actualiza el cronograma de instantáneas para un clúster en el proyecto especificado.

  • clusterCheckpointIntervalMin integer(int32) Requerido

    Cantidad de tiempo expresada en minutos entre puntos de control consecutivos en el clúster. Este parámetro solo se aplica a los clústeres fragmentados. Este número determina la granularidad de las copias de seguridad continuas en la nube para clústeres particionados.

    Los valores son 15, 30 o 60.

  • clusterId string Requerido

    string de 24 dígitos hexadecimales única que identifica el clúster junto con el snapshot que deseas devolver.

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

  • dailySnapshotRetentionDays integer(int32) Requerido

    Cantidad de tiempo para conservar instantáneas diarias. MongoDB Cloud expresa este valor en días. Establece este valor en 0 para deshabilitar la retención diaria de snapshot.

    Los valores son 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180 o 360.

  • monthlySnapshotRetentionMonths integer(int32) Requerido

    Número de meses que MongoDB nube debe conservar los snapshots mensuales. Configura este valor en 0 para desactivar la retención de instantáneas mensuales.

    Los valores son 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, o 36.

  • pointInTimeWindowHours integer(int32) Requerido

    Número de horas antes de la hora actual desde las que MongoDB Cloud puede crear una snapshot de copia de seguridad continua en la nube.

  • snapshotIntervalHours integer(int32) Requerido

    Número de horas que deben transcurrir antes de tomar otra snapshot.

    Los valores son 6, 8, 12 o 24.

  • diasDeRetenciónDeInstantáneas integer(int32) Requerido

    Número de días que MongoDB nube debe conservar snapshots recientes.

    Los valores son 2, 3, 4 o 5.

  • weeklySnapshotRetentionWeeks integer(int32) Requerido

    Número de semanas que MongoDB nube debe mantener las snapshots semanales. Establezca este valor en 0 para desactivar la retención semanal de instantáneas.

    Los valores son 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24 o 52.

Respuestas

  • 200 application/json

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • clusterCheckpointIntervalMin integer(int32) Requerido

      Cantidad de tiempo expresada en minutos entre puntos de control consecutivos en el clúster. Este parámetro solo se aplica a los clústeres fragmentados. Este número determina la granularidad de las copias de seguridad continuas en la nube para clústeres particionados.

      Los valores son 15, 30 o 60.

    • clusterId string Requerido

      string de 24 dígitos hexadecimales única que identifica el clúster junto con el snapshot que deseas devolver.

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

    • dailySnapshotRetentionDays integer(int32) Requerido

      Cantidad de tiempo para conservar instantáneas diarias. MongoDB Cloud expresa este valor en días. Establece este valor en 0 para deshabilitar la retención diaria de snapshot.

      Los valores son 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180 o 360.

    • ID del grupo string Requerido

      string hexadecimal única de 24dígitos que identifica el Proyecto que contiene el clúster.

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

    • monthlySnapshotRetentionMonths integer(int32) Requerido

      Número de meses que MongoDB nube debe conservar los snapshots mensuales. Configura este valor en 0 para desactivar la retención de instantáneas mensuales.

      Los valores son 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, o 36.

    • pointInTimeWindowHours integer(int32) Requerido

      Número de horas antes de la hora actual desde las que MongoDB Cloud puede crear una snapshot de copia de seguridad continua en la nube.

    • snapshotIntervalHours integer(int32) Requerido

      Número de horas que deben transcurrir antes de tomar otra snapshot.

      Los valores son 6, 8, 12 o 24.

    • diasDeRetenciónDeInstantáneas integer(int32) Requerido

      Número de días que MongoDB nube debe conservar snapshots recientes.

      Los valores son 2, 3, 4 o 5.

    • weeklySnapshotRetentionWeeks integer(int32) Requerido

      Número de semanas que MongoDB nube debe mantener las snapshots semanales. Establezca este valor en 0 para desactivar la retención semanal de instantáneas.

      Los valores son 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24 o 52.

  • 400 application/json

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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.

  • 401 application/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    No se ha encontrado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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.

PATCH /api/atlas/v1.0/groups/{groupId}/clústeres/{clusterName}/snapshotSchedule
curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/snapshotSchedule' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"clusterCheckpointIntervalMin":15,"clusterId":"32b6e34b3d91647abb20e7b8","dailySnapshotRetentionDays":0,"monthlySnapshotRetentionMonths":0,"pointInTimeWindowHours":42,"snapshotIntervalHours":6,"snapshotRetentionDays":2,"weeklySnapshotRetentionWeeks":0}'
Solicitar ejemplos
{
  "clusterCheckpointIntervalMin": 15,
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "dailySnapshotRetentionDays": 0,
  "monthlySnapshotRetentionMonths": 0,
  "pointInTimeWindowHours": 42,
  "snapshotIntervalHours": 6,
  "snapshotRetentionDays": 2,
  "weeklySnapshotRetentionWeeks": 0
}
Ejemplos de respuesta (200)
{
  "clusterCheckpointIntervalMin": 15,
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "dailySnapshotRetentionDays": 0,
  "groupId": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "monthlySnapshotRetentionMonths": 0,
  "pointInTimeWindowHours": 42,
  "snapshotIntervalHours": 6,
  "snapshotRetentionDays": 2,
  "weeklySnapshotRetentionWeeks": 0
}
Ejemplos de respuesta (400)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}