Devolver todos los clústeres flexibles de un proyecto

Obtener /api/atlas/v2/groups/{groupId}/flexClusters

Devuelve detalles de todos los clústeres flexibles 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.

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

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.

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

  • 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.2024-11-13+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.

      Grupo de configuraciones que configuran un clúster MongoDB Flex.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • Configuración de copia de seguridad Objeto

        Configuración de copia de seguridad flexible.

        Ocultar el atributo backupSettings Mostrar el atributo backupSettings Objeto
        • habilitado booleano

          Indicador que indica si se realizan copias de seguridad para este clúster flexible. La copia de seguridad utiliza copias de seguridad del clúster flexible.

          El valor predeterminado es true.

          Copias de seguridad de clústeres flexibles
      • tipo de clúster string

        Topología de clúster flexible.

        El valor es REPLICASET. El valor predeterminado es REPLICASET.

      • cadenas de conexión Objeto

        Colección de localizadores uniformes de recursos que apuntan a la base de datos MongoDB.

        Formato de URI de cadena de conexión.
        Ocultar atributos de connectionStrings Mostrar atributos de connectionStrings Objeto
      • fecha de creación cadena(fecha-hora)

        Fecha y hora en que MongoDB Cloud creó esta instancia. Este parámetro expresa su valor en formato ISO 8601 en UTC.

      • ID de grupo string

        Cadena de caracteres hexadecimales 24única que identifica el proyecto.

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

      • ID. string

        Cadena de dígitos hexadecimales 24única que identifica la instancia.

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

      • Versión de MongoDB string

        Versión de MongoDB que ejecuta la instancia.

        El formato debe coincidir con el siguiente patrón: ([\d]+\.[\d]+\.[\d]+).

      • Nombre string

        Etiqueta legible por humanos que identifica la instancia.

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

      • Configuración del proveedor Objeto Requerido

        Grupo de configuraciones del proveedor de nube que configuran el clúster flexible MongoDB aprovisionado.

        Ocultar atributos providerSettings Mostrar atributos de providerSettings Objeto
        • nombreDeProveedorDeRespaldo string

          Proveedor de servicios en la nube en el que MongoDB Cloud aprovisionó el flex clúster.

          Los valores son AWS, AZURE o GCP.

        • diskSizeGB número(doble)

          Capacidad de almacenamiento disponible para el clúster flexible expresada en gigabytes.

        • nombreProveedor string

          Etiqueta legible por humanos que identifica el tipo de proveedor.

          El valor es FLEX. El valor predeterminado es FLEX.

        • nombreDeRegión string

          Etiqueta legible que identifica la ubicación geográfica de su clúster flexible de MongoDB. La región que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos. Para obtener una lista completa de los nombres de las regiones, consulte AWS, GCP y Azure.

      • nombre del estado string

        Etiqueta legible que indica cualquier actividad actual que el plano de control de Atlas esté realizando en este clúster. Con excepción de los estados CREANDO y ELIMINANDO, los clústeres siempre deben estar disponibles y tener un nodo principal, incluso en estados que indiquen actividad continua.

        • IDLEAtlas no está realizando cambios en este clúster y se puede asumir que se han aplicado todos los cambios solicitados a través de la interfaz de usuario o la API.
        • CREATINGUn clúster que se aprovisiona por primera vez devuelve el estado CREANDO hasta que esté listo para las conexiones. Asegúrese de que la lista de acceso IP y los usuarios de la base de datos estén configurados antes de intentar la conexión.
        • UPDATING: Se está realizando un cambio solicitado a través de la Interfaz de Usuario, API, AutoScaling u otra actividad programada.
        • DELETING:El clúster está en proceso de eliminación y pronto se eliminará.
        • REPAIRINGEl plano de control de Atlas está volviendo a poner en servicio uno o más nodos del clúster. Los demás nodos deberían seguir prestando servicio con normalidad.

        Los valores son IDLE, CREATING, UPDATING, DELETING o REPAIRING.

      • Etiquetas matriz[objeto]

        Lista que contiene pares clave-valor de entre 1 y 255 caracteres de longitud para etiquetar y categorizar la instancia.

        Par clave-valor que etiqueta y categoriza una organización, proyecto o clúster de MongoDB Cloud. Por ejemplo, environment : production.

        Resource Tags
        Hide tags attributes Mostrar atributos de etiquetas Objeto
        • clave string Requerido

          Constante que define el conjunto de la etiqueta. Por ejemplo, environment en la etiqueta environment : production.

          La longitud mínima es 1, la longitud máxima es 255.

        • valor string Requerido

          Variable que pertenece al conjunto de la etiqueta. Por ejemplo, production en la etiqueta environment : production.

          La longitud mínima es 1, la longitud máxima es 255.

      • TerminaciónProtecciónHabilitada booleano

        Indicador que indica si la protección contra la terminación está habilitada en el clúster. Si se establece en true, MongoDB Cloud no eliminará el clúster. Si se establece en false, MongoDB Cloud eliminará el clúster.

        El valor predeterminado es false.

      • versiónReleaseSystem string

        Método mediante el cual el clúster mantiene las versiones de MongoDB.

        El valor es LTS. El valor predeterminado es LTS.

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

  • 409 aplicación/json

    Conflicto.

    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/groups/{groupId}/flexClusters
atlas api flexClusters listFlexClusters --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.ListGroupFlexClustersApiParams{}
	sdkResp, httpResp, err := client.FlexClustersApi.
		ListGroupFlexClustersWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true"
Ejemplos de respuestas (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "backupSettings": {
        "enabled": true
      },
      "clusterType": "REPLICASET",
      "connectionStrings": {
        "standard": "string",
        "standardSrv": "string"
      },
      "createDate": "2026-05-04T09:42:00Z",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBVersion": "string",
      "name": "string",
      "providerSettings": {
        "backingProviderName": "AWS",
        "diskSizeGB": 42.0,
        "providerName": "FLEX",
        "regionName": "string"
      },
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false,
      "versionReleaseSystem": "LTS"
    }
  ],
  "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 (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
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"
}