Programación de devolución de una instantánea Obsoleto

Obtener /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/programación de instantáneas

Devuelve la programación de instantáneas de un clúster del proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de solo lectura del proyecto.

A partir del 23 de marzo del 2020, todos los clústeres nuevos solo podrán usar copias de seguridad en la nube. Al actualizar a 4.2, su sistema de copias de seguridad se actualiza a la copia de seguridad en la nube si está configurado con copias de seguridad heredadas. Después de esta actualización, todas sus instantáneas de copias de seguridad heredadas existentes seguirán disponibles. Caducan con el tiempo según su política de retención. Su política de copias de seguridad se restablece a la programación predeterminada. Si tenía una política de copias de seguridad personalizada con copias de seguridad heredadas, debe volver a crearla siguiendo el procedimiento descrito en la documentación de Copia de seguridad en la nube.

Documentación de copia de seguridad en la nube

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 con la instantánea que desea devolver.

    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.

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita

Respuestas

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

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Intervalo mínimo del punto de control del clúster integer(int32) Requerido

      Tiempo expresado en minutos entre puntos de control sucesivos del clúster. Este parámetro solo se aplica a clústeres fragmentados. Este número determina la granularidad de las copias de seguridad continuas en la nube para clústeres fragmentados.

      Los valores son 15, 30 o 60.

    • clusterId string Requerido

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

    • Días de retención de instantáneas diarias integer(int32) Requerido

      Tiempo durante el cual se conservan las instantáneas diarias. MongoDB Cloud expresa este valor en días. Configure este valor en 0 para deshabilitar la conservación de instantáneas diarias.

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

    • ID de grupo string Requerido

      Cadena de dígitos hexadecimales 24única que identifica el proyecto que contiene el clúster.

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

    • Meses de retención de instantáneas mensuales integer(int32) Requerido

      Número de meses que MongoDB Cloud debe conservar las instantáneas mensuales. Configure este valor en 0 para desactivar la retención mensual de instantáneas.

      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 a partir de las cuales MongoDB Cloud puede crear una instantánea de copia de seguridad continua en la nube.

    • snapshotIntervalHours integer(int32) Requerido

      Número de horas que deben transcurrir antes de tomar otra instantánea.

      Los valores son 6, 8, 12 o 24.

    • Días de retención de instantáneas integer(int32) Requerido

      Número de días que MongoDB Cloud debe conservar las instantáneas recientes.

      Los valores son 2, 3, 4 o 5.

    • Semanas de retención de instantáneas semanales integer(int32) Requerido

      Número de semanas que MongoDB Cloud debe conservar las instantáneas semanales. Configure 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.

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

OBTENER /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/snapshotSchedule
atlas api legacyBackup getClusterSnapshotSchedule --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20240805001/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.GetGroupClusterSnapshotScheduleApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		GetGroupClusterSnapshotScheduleWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-08-05+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-08-05+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true"
Ejemplos de respuestas (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 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"
}