Devolver todos los trabajos de exportación de instantáneas

Obtener /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/copia de seguridad/exportaciones

Devuelve todos los trabajos de exportación de instantáneas de Cloud Backup asociados al clúster Atlas especificado. 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.

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita
  • incluirConteo booleano

    Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor predeterminado es true.

  • artículos por página entero

    Número de elementos que la respuesta devuelve por página.

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

  • número de página entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

Respuestas

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

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • resultados matriz[objeto]

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • componentes matriz[objeto]

        Información sobre el trabajo de exportación para cada conjunto de réplicas en el clúster fragmentado.

        Ocultar atributos de componentes Mostrar atributos de componentes Objeto
        • exportId string

          Cadena de caracteres hexadecimales 24única que identifica el trabajo de exportación de instantáneas de Cloud Backup para cada fragmento en un clúster fragmentado.

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

        • nombreConjuntoRéplica string

          Etiqueta legible por humanos que identifica el conjunto de réplicas en el clúster fragmentado.

      • creadoEn cadena(fecha-hora)

        Fecha y hora en que un usuario o Atlas creó el trabajo de exportación. MongoDB Cloud representa esta marca de tiempo en formato ISO 8601 en UTC.

      • datos personalizados matriz[objeto]

        Colección de pares clave-valor que representan datos personalizados para el archivo de metadatos que MongoDB Cloud carga cuando finaliza el trabajo de exportación.

        Colección de pares clave-valor que representan datos personalizados para agregar al archivo de metadatos que MongoDB Cloud carga en el bucket cuando finaliza el trabajo de exportación.

        Ocultar atributos de datos personalizados Mostrar atributos de datos personalizados Objeto
        • clave string

          Clave para el archivo de metadatos que MongoDB Nube carga en el bucket cuando se completa la tarea de exportación.

        • valor string

          Valor de la clave que se incluirá en el archivo que MongoDB Cloud carga en el depósito cuando finaliza el trabajo de exportación.

      • exportBucketId string Requerido

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

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

      • estado de exportación Objeto

        Estado del Trabajo Exportador.

        Ocultar atributos de exportStatus Mostrar los atributos exportStatus Objeto
        • colecciones exportadas integer(int32)

          Recuento de colecciones cuyos documentos fueron exportados al contenedor de exportación.

        • Colecciones totales integer(int32)

          Recuento total de colecciones cuyos documentos se exportarán al contenedor de exportación.

      • Terminado en cadena(fecha-hora)

        Fecha y hora de finalización de este trabajo de exportación. MongoDB Cloud representa esta marca de tiempo en formato ISO 8601 en UTC.

      • ID. string

        Cadena de caracteres hexadecimales 24única que identifica el trabajo de restauración.

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

      • prefix string

        Prefijo utilizado para todos los objetos de almacenamiento de blobs cargados como parte del trabajo de exportación.

        El formato debe coincidir con el siguiente patrón: /exported_snapshots/\{ORG-NAME\}/\{PROJECT-NAME\}/\{CLUSTER-NAME\}/\{SNAPSHOT-INITIATION-DATE\}/\{TIMESTAMP\}.

      • snapshotId string

        Cadena de caracteres hexadecimales 24única que identifica la instantánea.

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

      • Estado string

        Estado del Trabajo Exportador.

        Los valores son Cancelled, Failed, InProgress, Queued o Successful.

      • estadoRazón Objeto

        Indicar el motivo del trabajo. Esto se establece cuando el estado del trabajo es "Fallido".

        Ocultar atributos de stateReason Mostrar atributos de stateReason Objeto
        • errorCode string

          Código de error relacionado con el estado.

        • Mensaje string

          Mensaje que describe el error o estado.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount se establece en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 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}/copia de seguridad/exportaciones
atlas api cloudBackups listBackupExports --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230201001/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.ListGroupClusterBackupExportsApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		ListGroupClusterBackupExportsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true"
Ejemplos de respuestas (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "components": [
        {
          "exportId": "32b6e34b3d91647abb20e7b8",
          "replicaSetName": "string"
        }
      ],
      "createdAt": "2026-05-04T09:42:00Z",
      "customData": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "exportBucketId": "32b6e34b3d91647abb20e7b8",
      "exportStatus": {
        "exportedCollections": 42,
        "totalCollections": 42
      },
      "finishedAt": "2026-05-04T09:42:00Z",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "prefix": "string",
      "snapshotId": "32b6e34b3d91647abb20e7b8",
      "state": "Cancelled",
      "stateReason": {
        "errorCode": "string",
        "message": "string"
      }
    }
  ],
  "totalCount": 42
}
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"
}