Eliminar todos los cronogramas de copias de seguridad en la nube

Borrar /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/schedule

Elimina todas las programaciones de copias de seguridad en la nube del clúster especificado. Esta programación define cuándo MongoDB Cloud toma instantáneas programadas y durante cuánto tiempo las almacena. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de administrador de Project Atlas.

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.

    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.

Respuestas

  • 200 aplicación/json

    Vale

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

      Indicador que indica si MongoDB Cloud exporta automáticamente los snapshot de copias de seguridad en la nube al Bucket de exportación.

    • clusterId string

      string única de dígitos hexadecimales 24que identifica el clúster con la Snapshot que se desea devolver.

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

    • Nombre del clúster string

      Etiqueta legible por humanos que identifica el clúster con la instantánea que desea devolver.

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

    • copyPolicyItemsEnabled booleano

      Indicador que indica si la configuración de copia utiliza copyPolicyItems en lugar de frequencies. Cuando es verdadero, las solicitudes deben proporcionar copyPolicyItems, y las respuestas solo devuelven copyPolicyItems. Cuando es falso o se omite, las solicitudes deben suministrar frequencies y las respuestas devuelven solo frequencies.

    • CopiarConfiguración arreglo[objeto]

      Lista que contiene un documento para cada elemento de configuración de copia en la política de copia de seguridad deseada.

      Ocultar atributos de copySettings Mostrar atributos de copySettings Objeto

      Copie el elemento de configuración en la política de respaldo deseada.

      • Proveedor de la nube string

        Etiqueta legible por humanos que identifica el proveedor de nube que almacena la copia del snapshot.

        Los valores son AWS, AZURE o GCP.

      • copyPolicyItems arreglo[objeto]

        Lista que describe la retención por cada elemento de la política de copias. Permitido solo cuando copyPolicyItemsEnabled es verdadero. Las respuestas omiten este campo cuando copyPolicyItemsEnabled es falso o no se especifica.

        No más de 6 elementos.

        Uno de:
      • frecuencias array[string] Obsoleto

        Obsoleto: usar copyPolicyItems, que define qué instantáneas copiar y su conservación. Solo se permite cuando copyPolicyItemsEnabled es falso o se omite. Las respuestas omiten este campo cuando copyPolicyItemsEnabled es verdadero.

        No más de 6 elementos. Los valores son HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY o ON_DEMAND.

      • últimoNúmeroDeInstantáneas integer(int32)

        Número de instantáneas más recientes a copiar a la región de destino. Si se especifica, Atlas copia esta cantidad de los snapshot más recientes en lugar de utilizar un cronograma de copias basado en la frecuencia o basado en políticas. Este campo es mutuamente exclusivo con frequencies y copyPolicyItems.

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

      • Nombre de la región string

        Región de destino a la que se deben copiar las instantáneas que pertenecen a replicationSpecId. Por favor, proporciona la "Región Atlas".

        Regiones de proveedores de nube
      • replicationSpecId string

        Cadena única de dígitos hexadecimales 24que identifica el objeto de replicación de una zona en un clúster. En clústeres globales, se pueden elegir varias zonas. En clústeres fragmentados y clústeres de conjuntos de réplicas, solo hay una zona en el clúster. Para encontrar el ID de especificación de replicación, realice una solicitud GET para devolver un clúster de un proyecto y consulte la matriz replicationSpecs.

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

        Devolver un clúster de uno pr...
      • deberíaCopiarOplogs booleano

        Indicador que señala si se deben copiar los 'oplogs' a la región objetivo. Puede utilizar los oplogs para realizar restauraciones a un punto específico del tiempo.

    • exportación Objeto

      Política para exportar automáticamente snapshots de copias de seguridad en la nube.

      Ocultar atributos de exportación Mostrar atributos de exportación Objeto
      • exportBucketId string

        String única de caracteres hexadecimales 24que identifica el Export Bucket.

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

      • frequencyType string

        Etiqueta legible por humanos que indica la frecuencia con la que ocurre el elemento de la política de exportación.

        Los valores son monthly o yearly.

    • extraRetentionSettings arreglo[objeto]

      Lista que contiene un documento para cada elemento de configuración de retención adicional en la política de respaldo deseada.

      Ocultar atributos extraRetentionSettings Mostrar atributos extraRetentionSettings Objeto

      Elemento de configuración de retención adicional en la política de copia de seguridad deseada.

      • frequencyType string

        El tipo de frecuencia para las configuraciones de retención adicional para el clúster.

        Los valores son HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY o ON_DEMAND.

      • retentionDays integer(int32)

        La cantidad de días de retención adicionales para el clúster.

    • siguienteInstantánea string(date-time)

      Fecha y hora en la que MongoDB nube realiza la siguiente snapshot. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • políticas arreglo[objeto] Requerido

      Reglas establecidas para este cronograma de copia de seguridad.

      No más de 1 elementos.

      Ocultar los atributos de la política Mostrar atributos de políticas Objeto

      Lista que contiene un documento para cada elemento de la política de respaldo en la política de respaldo deseada.

      • ID string

        Cadena de dígitos hexadecimales 24única que identifica esta política de respaldo.

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

      • policyItems arreglo[objeto] Requerido

        Lista que contiene las especificaciones para una política.

        Ocultar atributos de policyItems Mostrar atributos de policyItems Objeto

        Especificaciones para una política.

        • frequencyInterval integer(int32) Requerido

          Número que indica el intervalo de frecuencia para un conjunto de snapshots. Un valor de 1 especifica la primera instancia del correspondiente frequencyType.

          • En un elemento de política anual, 1 indica que la snapshot anual se produce el primer día de enero y 12 indica el primer día de diciembre.

          • En un elemento de política mensual, 1 indica que la instantánea mensual ocurre el primer día del mes y 40 indica el último día del mes.

          • En un elemento de política semanal, 1 indica que el snapshot semanal se lleva a cabo el lunes y 7 indica el domingo.

          • En un elemento de política horaria, puedes establecer el intervalo de frecuencia en 1, 2, 4, 6, 8 o 12. Para los elementos de la política por hora para clústeres NVMe, MongoDB Cloud solo acepta 12 como valor del intervalo de frecuencia.

          MongoDB Cloud ignora esta configuración para los elementos de política que no son por hora en la configuración de la Política de cumplimiento de respaldo.

          Los valores son 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, o 40.

        • frequencyType string Requerido

          Etiqueta legible por humanos que identifica el tipo de frecuencia asociado con la política de copia de seguridad.

          Los valores son daily, hourly, weekly, monthly, yearly o ondemand.

        • ID string

          Cadena única de 24dígitos hexadecimales que identifica este elemento de la política de copias de seguridad.

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

        • retentionUnit string Requerido

          Unidad de tiempo en la que MongoDB nube mide la retención de instantáneas.

          Los valores son days, weeks, months o years.

        • valorDeRetención integer(int32) Requerido

          Duración en días, semanas, meses o años que MongoDB Cloud conserva la instantánea. Para elementos de política menos frecuentes, MongoDB Cloud requiere que especifique un valor mayor o igual al especificado para elementos de política más frecuentes.

          Por ejemplo: Si el elemento de la política por hora especifica una retención de dos días, debes especificar dos días o más para la retención del elemento de la política semanal.

    • referenciaHoraDelDía integer(int32)

      Hora del día en la Hora Universal Coordinada (UTC) que representa cuando MongoDB Cloud toma la snapshot.

    • referenciaMinutoDeHora integer(int32)

      Minuto del referenceHourOfDay que representa cuando MongoDB nube toma el snapshot.

    • restaurarVentanaDías integer(int32)

      Número de días anteriores a los que puedes restaurar con la precisión de copia de seguridad continua en la nube. Debes especificar un número entero positivo y distinto de cero. Este parámetro aplica únicamente a las copias de seguridad continuas en la nube.

    • useOrgAndGroupNamesInExportPrefix booleano

      Indicador que señala si se deben utilizar nombres de organización y proyecto en lugar de UUIDs de organización y proyecto en la ruta hacia los archivos de metadatos que MongoDB Cloud carga en tu Export Bucket.

  • 400 aplicación/json

    Solicitud incorrecta.

    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.

  • 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.

BORRAR /api/Atlas/v1.0/groups/{groupId}/clusters/{clusterName}/copia de seguridad/cronograma
curl \
 --request DELETE 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/schedule' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "autoExportEnabled": true,
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "copyPolicyItemsEnabled": true,
  "copySettings": [
    {
      "cloudProvider": "AWS",
      "copyPolicyItems": [
        {
          "frequencyType": "ondemand",
          "id": "32b6e34b3d91647abb20e7b8"
        }
      ],
      "frequencies": [
        "HOURLY"
      ],
      "lastNumberOfSnapshots": 42,
      "regionName": "string",
      "replicationSpecId": "32b6e34b3d91647abb20e7b8",
      "shouldCopyOplogs": true
    }
  ],
  "export": {
    "exportBucketId": "32b6e34b3d91647abb20e7b8",
    "frequencyType": "monthly"
  },
  "extraRetentionSettings": [
    {
      "frequencyType": "HOURLY",
      "retentionDays": 42
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "nextSnapshot": "2026-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
}
Ejemplos de respuestas (400)
{
  "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"
}
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"
}