Devolver una entrada de la lista de acceso IP de un proyecto

OBTENER /api/atlas/v1.0/groups/{groupId}/accessList/{entryValue}

Devuelve una entrada de la lista de acceso desde la lista de acceso IP del proyecto especificado. Cada entrada en la lista de acceso IP del proyecto contiene una dirección IP o un bloque de direcciones IP en notación CIDR. MongoDB Cloud solo permite conexiones de clientes al clúster desde las entradas en la lista de acceso IP del proyecto. Para utilizar este recurso, la cuenta de servicio solicitante o la clave de API debe tener los roles de Solo Lectura de Proyecto o Administrador de Charts de Proyecto. Este recurso reemplaza el recurso whitelist. MongoDB Cloud eliminó las listas blancas en julio de 2021. Actualiza tus aplicaciones para que utilicen este nuevo recurso. Este endpoint (/groups/{GROUP-ID}/accessList) gestiona la lista de acceso IP del proyecto. No gestiona la lista de acceso para las organizaciones de MongoDB nube. El endpoint de claves API programáticas (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) gestiona esas listas de acceso.

lista de acceso IP

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

  • entryValue string Requerido

    Entrada de la lista de acceso que deseas devolver de la lista de acceso IP del proyecto. Este valor puede usar uno de los siguientes: un ID del grupo de seguridad de AWS, una dirección IP o un bloque CIDR de direcciones. Para los bloques CIDR que utilizan una máscara de subred, reemplaza la barra diagonal (/) por su valor codificado en URL (%2F).

    El formato debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\:){1,6}\:(%2[fF][0-9]{1,3})|(sg\-[a-f0-9]{8})?$.

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
    • awsSecurityGroup string

      string única del grupo de seguridad de Amazon Web Services (AWS) que se desea añadir a la lista de acceso IP del proyecto. Tu entrada a la lista de acceso IP puede ser un awsSecurityGroup, un cidrBlock o un ipAddress. Debe configurar la conexión de emparejamiento de red privada virtual (VPC) para su proyecto antes de poder añadir un grupo de seguridad de AWS a una lista de acceso IP. No se pueden establecer los grupos de seguridad de AWS como entradas temporales en la lista de acceso. No configures este parámetro si configuras cidrBlock o ipAddress.

      El formato debe coincidir con el siguiente patrón: ^([0-9]*/)?sg-([0-9]*).

    • cidrBlock string

      Rango de direcciones IP en notación CIDR (enrutamiento entre dominios sin clase) que se desea agregar a la lista de acceso IP del proyecto. Tu entrada a la lista de acceso IP puede ser un awsSecurityGroup, un cidrBlock o un ipAddress. No establezcas este parámetro si has establecido awsSecurityGroup o ipAddress.

      El formato debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\:){1,6}\:(%2[fF][0-9]{1,3})?$.

    • comment string

      Observación que explica el propósito o el alcance de esta entrada de la lista de acceso IP.

      La longitud máxima es 80.

    • deleteAfterDate string(date-time)

      Fecha y hora en la que MongoDB Nube borra la entrada temporal de la lista de acceso. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC y puede incluir la designación de la zona horaria. La fecha debe ser posterior a la fecha actual, pero no más de una semana después de que envíes esta solicitud. El recurso devuelve este parámetro si especificó una fecha de vencimiento al crear esta entrada en la lista de acceso IP.

    • ID del grupo string

      Cadena de dígitos hexadecimales 24única que identifica el proyecto que contiene la lista de acceso IP a la que desea agregar una o más entradas.

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

    • Dirección IP string

      Dirección IP que deseas añadir a la lista de acceso IP del proyecto. La entrada de tu lista de acceso IP puede ser un awsSecurityGroup, un cidrBlock o un ipAddress. No establezcas este parámetro si estableces awsSecurityGroup o cidrBlock.

      El formato debe coincidir con el siguiente patrón: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

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

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

OBTENER /api/atlas/v1.0/grupos/{ID de grupo}/lista de acceso/{valor de entrada}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/accessList/IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "awsSecurityGroup": "string",
  "cidrBlock": "string",
  "comment": "string",
  "deleteAfterDate": "2026-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "ipAddress": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ]
}
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"
}