Eliminar todas las programaciones de copias de seguridad en la nube Obsoleto

ELIMINAR /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/copia de seguridad/programación

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 ruta

  • ID de grupo string Requerido

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

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

  • envolvente booleano

    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.

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • autoExportación habilitada booleano

      Bandera que indica si MongoDB Cloud exporta automáticamente instantáneas de Cloud Backup al depósito de exportación.

    • clusterId string

      Cadena de dígitos hexadecimales 24única que identifica el clúster con la instantánea que 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

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

    • CopiarConfiguración matriz[objeto]

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

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

      Ocultar atributos de copySettings Mostrar atributos de copySettings Objeto
      • Proveedor de la nube string

        Etiqueta legible por humanos que identifica al proveedor de la nube que almacena la copia de la instantánea.

        Los valores son AWS, AZURE o GCP.

      • copyPolicyItems matriz[objeto]

        Lista que describe la retención por elemento de la política de copia. Solo se permite cuando copyPolicyItemsEnabled es verdadero. Las respuestas omiten este campo cuando copyPolicyItemsEnabled es falso o se omite.

        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 que se copiarán en la región de destino. Si se especifica, Atlas copia este número de instantáneas más recientes en lugar de usar una programación de copia basada en frecuencia o política. Este campo es mutuamente excluyente con frequencies y copyPolicyItems.

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

      • nombreDeRegión string

        Región de destino donde se copiarán las instantáneas pertenecientes a replicationSpecId. Indique 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 un pr...
      • shouldCopyOplogs booleano

        Indicador que indica si se deben copiar los registros de operaciones a la región de destino. Puede usar los registros de operaciones para realizar restauraciones puntuales.

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

      • tipo de frecuencia string

        Etiqueta legible para humanos que indica la velocidad a la que se produce el elemento de la política de exportación.

        Los valores son monthly o yearly.

    • Ajustes de retención adicionales matriz[objeto]

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

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

      Ocultar atributos extraRetentionSettings Mostrar atributos extraRetentionSettings Objeto
      • tipo de frecuencia 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.

      • días de retención integer(int32)

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

    • siguienteInstantánea cadena(fecha-hora)

      Fecha y hora en que MongoDB Cloud toma la siguiente instantánea. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • políticas matriz[objeto]

      Reglas establecidas para esta programación de copias de seguridad.

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

      No más de 1 elemento.

      Ocultar atributos de políticas Mostrar atributos de políticas Objeto
      • 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})$.

      • elementos de política matriz[objeto]

        Lista que contiene las especificaciones de una política.

        Especificaciones para una póliza.

        Ocultar atributos de policyItems Mostrar atributos de policyItems Objeto
        • 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 instantánea anual ocurre 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 la instantánea semanal ocurre el lunes y 7 indica el domingo.

          • En un elemento de política horaria, puede establecer el intervalo de frecuencia en 1, 2, 4, 6, 8 o 12. Para elementos de política horaria de clústeres NVMe, MongoDB Cloud solo acepta 12 como valor de 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.

        • tipo de frecuencia string Requerido

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

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

        • ID. string

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

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

        • unidad de retención 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 política por hora especifica una retención de dos días, debe especificar dos días o más para la retención del elemento de política semanal.

    • referenciaHoraDelDía integer(int32)

      Hora del día en Tiempo Universal Coordinado (UTC) que representa cuándo MongoDB Cloud toma la instantánea.

    • referenciaMinutoDeHora integer(int32)

      Minuto del referenceHourOfDay que representa cuando MongoDB Cloud toma el Snapshot.

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

    • usar nombres de organizaciones y grupos en el prefijo de exportación booleano

      Bandera que indica si se deben utilizar nombres de organización y proyecto en lugar de UUID de organización y proyecto en la ruta a los archivos de metadatos que MongoDB Cloud carga en su Export Bucket.

  • 400 aplicación/json

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación 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 incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación 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 incorrecto.

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

        Describe todas las violaciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de 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 matriz[objeto]

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

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

ELIMINAR /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/copia de seguridad/programación
atlas api cloudBackups deleteClusterBackupSchedule --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/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.DeleteGroupClusterBackupScheduleApiParams{}
	httpResp, err := client.CloudBackupsApi.
		DeleteGroupClusterBackupScheduleWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule"
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"
}