Devolver una instancia sin servidor de un proyecto Obsoleto

OBTENER /api/atlas/v1.0/groups/{groupId}/serverless/{name}

Devuelve detalles de una instancia sin servidor en el Proyecto especificado. Para utilizar este recurso, la cuenta de servicio o la clave de API que realiza la solicitud debe tener el rol Solo lectura del proyecto.

Esta API también se puede usar en clústeres Flex que se crearon con el endpoint Create instancia sin servidor o en clústeres Flex que fueron migrados desde instancias sin servidor. Las copias de seguridad continuas no son compatibles y serverlessContinuousBackupEnabled no entrará en vigor en estos clústeres. Este endpoint se descontinuará el 15 de enero de 2027. Por favor, utiliza el endpoint Get Flex clúster en su lugar.

Obtener Flex clúster

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

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

  • Nombre string Requerido

    Etiqueta legible por humanos que identifica la instancia sin servidor.

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

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

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

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • cadenas de conexión Objeto

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

      Formato URI de la cadena de conexión.
      Ocultar atributos de connectionStrings Mostrar los atributos de connectionStrings Objeto
      • Nodo privado arreglo[objeto]

        Lista de cadenas de conexión con reconocimiento de punto final privado que puedes utilizar para conectar a esta instancia sin servidor a través de un punto final privado. Este parámetro solo se devuelve si se creó un nodo privado para esta instancia sin servidor y está DISPONIBLE.

        Ocultar atributos de privateEndpoint Mostrar atributos de privateEndpoint Objeto

        Cadena de conexión de endpoint privado que puedes usar para conectarte a esta instancia sin servidor a través de un endpoint privado.

        Nodo privado para Serverles...
        • puntos finales arreglo[objeto]

          Lista que contiene los nodos privados a través de los cuales te conectas a MongoDB nube cuando utilizas connectionStrings.privateEndpoint[n].srvConnectionString.

          Ocultar atributos de los endpoints Mostrar atributos de los puntos finales Objeto

          Detalles de un endpoint privado desplegado para esta instancia sin servidor.

          • endpointId string

            string única que el proveedor de nube utiliza para identificar el endpoint privado.

          • providerName string

            Proveedor de nube donde se implementa el endpoint privado.

            Los valores son AWS o AZURE.

          • region string

            Región donde se implementa el endpoint privado.

        • cadena de conexión srv string

          Cadena de conexión que reconoce puntos finales privados y que utiliza el protocolo mongodb+srv:// para conectarse a MongoDB Cloud a través de un punto final privado. El protocolo mongodb+srv indica al controlador que busque la lista de hosts en el Sistema de Nombres de Dominio (DNS).

        • tipo string

          Tipo de proceso de MongoDB al que se conecta tu aplicación.

          El valor es MONGOS.

      • estándarSrv string

        Cadena de conexión pública que puedes usar para conectarte a esta instancia sin servidores. Esta cadena de conexión utiliza el protocolo mongodb+srv:// .

        Formato de URI de cadena de conexión
    • fecha de creación string(date-time)

      Fecha y hora en que MongoDB Cloud creó esta instancia sin servidor. MongoDB nube representa esta marca de tiempo en formato ISO 8601 en UTC.

    • ID del 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

      string única de dígitos hexadecimales 24que identifica la instancia sin servidor.

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

    • Versión de MongoDB string

      Versión de MongoDB en la que se ejecuta la instancia sin servidor.

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

    • Nombre string

      Etiqueta legible por humanos que identifica la instancia sin servidor.

      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 la instancia aprovisionada de MongoDB sin servidor.

      Ocultar atributos providerSettings Mostrar atributos de providerSettings Objeto
      • backingProviderName string Requerido

        Proveedor de servicios en la nube en el que MongoDB Cloud aprovisionó la instancia sin servidor.

        Los valores son AWS, AZURE o GCP.

      • límiteEfctivoTamañoGBDisco integer(int32)

        Capacidad de almacenamiento de los volúmenes de datos de la instancia expresada en gigabytes. Este valor no es configurable para sin servidor ni para clústeres Flex de manera efectiva.

      • effectiveInstanceSizeName string

        El límite de tamaño de la instancia al cual tu clúster puede escalar automáticamente.

        Uno de:

        Los valores son M10, M20, M30, M40, M50, M60, M80, M100, M140, M200, M300, R40, R50, R60, R80, R200, R300, R400, R700, M40_NVME, M50_NVME, M60_NVME, M80_NVME, M200_NVME o M400_NVME.

        Los valores son M10, M20, M30, M40, M50, M60, M80, M90, M200, R40, R50, R60, R80, R200, R300, R400, M60_NVME, M80_NVME, M200_NVME, M300_NVME, M400_NVME o M600_NVME.

        Los valores son M10, M20, M30, M40, M50, M60, M80, M140, M200, M250, M300, M400, R40, R50, R60, R80, R200, R300, R400 o R600.

      • nombreProveedorEfectivo string

        Proveedor de servicios en la nube en el que MongoDB Cloud aprovisionó eficazmente la instancia sin servidor.

      • providerName string

        Etiqueta legible por humanos que identifica al proveedor de servicios en la nube.

        El valor es SERVERLESS. El valor por defecto es SERVERLESS.

      • Nombre de la región string Requerido

        Etiqueta legible por humanos que identifica la ubicación geográfica de su instancia sin servidor de MongoDB. La región que elijas puede afectar la latencia de la red para los clientes que acceden a tus bases de datos. Para ver una lista completa de nombres de regiones, consulte AWS, GCP y Azure.

    • serverlessBackupOptions Objeto

      Grupo de configuraciones que configuran la copia de seguridad sin servidor.

      Ocultar el atributo serverlessBackupOptions Mostrar el atributo serverlessBackupOptions Objeto
      • serverlessContinuousBackupEnabled booleano

        Marca que indica si la instancia sin servidor utiliza la copia de seguridad continua sin servidor. Si este parámetro false es, la instancia sin servidor utiliza la copia de seguridad básica.

        | Opción | descripción | |---|---| | Copia de seguridad sin servidor | Atlas toma snapshots incrementales de los datos en tu instancia sin servidor cada seis horas y te permite restaurar los datos desde un punto específico en el tiempo dentro de las últimas 72 horas. Atlas también realiza snapshots diarias y conserva estas snapshots diarias durante 35 días. Para más información, consulta Costos de instancia sin servidor. | | Copia de seguridad Básica | Atlas realiza snapshots incrementales de los datos en su instancia sin servidor cada seis horas y solo conserva las dos snapshots más recientes. Puede utilizar esta opción de forma gratuita. |

        El valor por defecto es true.

    • stateName string

      Etiqueta legible por humanos que indica cualquier actividad actual que esté llevando a cabo el plano de control de Atlas en este clúster. Salvo en los estados de CREACIÓN y ELIMINACIÓN, los clústeres siempre deben estar disponibles y disponer de un nodo Primario, incluso cuando se encuentran en estados que indican actividad en curso.

      • IDLE: Atlas no está realizando ningún cambio en este clúster, y se puede asumir que todos los cambios solicitados a través de la interfaz de usuario o la API se han aplicado.
      • CREATING: Un clúster que se aprovisiona por primera vez retorna el estado CREANDO hasta que esté listo para recibir conexiones. Asegúrese de que la lista de acceso IP y los usuarios de la base de datos estén configurados antes de intentar conectarse.
      • 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á.
      • REPAIRING: Uno o más nodos del clúster están siendo devueltos al servicio por el plano de control de Atlas. Los demás nodos deben seguir prestando servicio con normalidad.

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

    • Etiquetas arreglo[objeto]

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

      Hide tags attributes Mostrar atributos de etiquetas Objeto

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

      • llave string Requerido

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

        La longitud mínima es de 1, la longitud máxima es de 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 de 1, la longitud máxima es de 255.

    • terminationProtectionEnabled booleano

      Marca que indica si la protección contra terminación está habilitada en la instancia sin servidor. Si se establece en true, MongoDB Cloud no eliminará la instancia sin servidor. Si se establece en false, MongoDB Cloud eliminará la instancia sin servidor.

      El valor por defecto es false.

  • 400 aplicación/json

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

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

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

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

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

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

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

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

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 409 aplicación/json

    Conflicto.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

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

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

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

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/groups/{groupId}/sin servidor/{name}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/serverless/{name}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "connectionStrings": {
    "privateEndpoint": [
      {
        "endpoints": [
          {
            "endpointId": "string",
            "providerName": "AWS",
            "region": "string"
          }
        ],
        "srvConnectionString": "string",
        "type": "MONGOS"
      }
    ],
    "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",
    "effectiveDiskSizeGBLimit": 42,
    "effectiveInstanceSizeName": "M10",
    "effectiveProviderName": "string",
    "providerName": "SERVERLESS",
    "regionName": "string"
  },
  "serverlessBackupOptions": {
    "serverlessContinuousBackupEnabled": true
  },
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false
}
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 (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"
}