Enumerar los clústeres de Atlas en un proyecto

OBTENER /api/v1/atlas/projects/{project_id}/clusters
Autorización del portador

Atlas Admin API utiliza los tokens delegados de un usuario o una cuenta de servicio de Agent Engine asociada para acceder a /groups/{id}/flexClusters. No se aceptan claves de API de Agent Engine. Se rechaza cualquier project_id no válido antes de realizar cualquier llamada a Atlas.

Parámetros de path

  • project_id string Requerido

    ID del proyecto Atlas

Respuestas

  • 406

    Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.

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

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

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

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.
  • 200

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Resultados arreglo[objeto]
      Ocultar los atributos de resultados Mostrar los atributos de los resultados Objeto
      • connection_string_srv string
      • es_flex booleano
      • Nombre string
      • Proveedor string
      • region string
      • nombre_del_estado string
      • tier string

        El nivel es FLEX para clústeres Flex y el tamaño de instancia Atlas (M10, M0, ...) en caso contrario, incluyendo los niveles gratuitos/compartidos. Se muestra sin filtrar para que los clientes puedan excluir los niveles gratuitos/compartidos de la selección de clústeres y rechazar su adopción; la plataforma no controla la selección en el servidor.

    • recuento_total entero
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Resultados arreglo[objeto]
      Ocultar los atributos de resultados Mostrar los atributos de los resultados Objeto
      • connection_string_srv string
      • es_flex booleano
      • Nombre string
      • Proveedor string
      • region string
      • nombre_del_estado string
      • tier string

        El nivel es FLEX para clústeres Flex y el tamaño de instancia Atlas (M10, M0, ...) en caso contrario, incluyendo los niveles gratuitos/compartidos. Se muestra sin filtrar para que los clientes puedan excluir los niveles gratuitos/compartidos de la selección de clústeres y rechazar su adopción; la plataforma no controla la selección en el servidor.

    • recuento_total entero
  • 400

    ID_NO_VÁLIDO: project_id no es un ID de proyecto Atlas en formato hexadecimal 24.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 401

    PLATFORM_OAUTH_REQUIRED o PLATFORM_OAUTH_RESOURCE_REJECTED

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 402

    MÉTODO DE PAGO ATLAS REQUERIDO

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 403

    ATLAS_PERMISSION_REQUIRED, ATLAS_SERVICE_ACCOUNT_NOT_PAIRED o PROHIBIDO

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 404

    NOT_FOUND

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 409

    Conflicto

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 500

    ERROR_INTERNO

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 502

    Atlas inaccesible / respuesta no correcta

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
  • 503

    PLATFORM_OAUTH_NOT_CONFIGURED o SERVICE_UNAVAILABLE cuando ya se está actualizando un token delegado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
GET /api/v1/atlas/projects/{project_id}/clusters 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/atlas/projects/{project_id}/clusters' \
 --header "Authorization: $API_KEY"
Ejemplos de respuesta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Ejemplos de respuesta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Ejemplos de respuesta (200) 
{
  "results": [
    {
      "connection_string_srv": "string",
      "is_flex": true,
      "name": "string",
      "provider": "string",
      "region": "string",
      "state_name": "string",
      "tier": "string"
    }
  ],
  "total_count": 42
}
Ejemplos de respuesta (200) 
{
  "results": [
    {
      "connection_string_srv": "string",
      "is_flex": true,
      "name": "string",
      "provider": "string",
      "region": "string",
      "state_name": "string",
      "tier": "string"
    }
  ],
  "total_count": 42
}
Ejemplos de respuesta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (402) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (402) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}