Devolver una entrada de la lista de acceso IP del proyecto

Obtener /api/atlas/v1.0/grupos/{ID de grupo}/lista de acceso/{valor de entrada}

Devuelve una entrada de la lista de acceso IP del proyecto especificado. Cada entrada de la lista de acceso IP del proyecto contiene una dirección IP o un bloque de direcciones IP con anotación CIDR. MongoDB Cloud solo permite conexiones de cliente al clúster desde entradas de la lista de acceso IP del proyecto. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener los roles de "Solo lectura del proyecto" o "Administrador de gráficos del proyecto". Este recurso reemplaza al recurso de lista blanca. MongoDB Cloud eliminó las listas blancas en julio de 2021. Actualice sus aplicaciones para usar este nuevo recurso. Este punto de conexión (/groups/{GROUP-ID}/accessList) administra la lista de acceso IP del proyecto. No administra la lista de acceso de las organizaciones de MongoDB Cloud. El punto de conexión "Claves API programáticas" (/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist) administra dichas listas de acceso.

lista de acceso IP

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

  • entryValue string Requerido

    Entrada de la lista de acceso que desea obtener de la lista de acceso IP del proyecto. Este valor puede usar uno de los siguientes: un ID de grupo de seguridad de AWS, una dirección IP o un bloque de direcciones CIDR. Para los bloques CIDR que usan una máscara de subred, reemplace 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 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

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Grupo de seguridad de AWS string

      Cadena única del grupo de seguridad de Amazon Web Services (AWS) que desea agregar a la lista de acceso IP del proyecto. La entrada de la lista de acceso IP puede ser awsSecurityGroup, cidrBlock o ipAddress. Debe configurar el emparejamiento de la conexión privada virtual (VPC) para su proyecto antes de agregar un grupo de seguridad de AWS a una lista de acceso IP. No puede configurar grupos de seguridad de AWS como entradas temporales de la lista de acceso. No configure este parámetro si configura cidrBlock o ipAddress.

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

    • bloque cidr string

      Rango de direcciones IP en notación CIDR (Enrutamiento Interdominio sin Clase) que desea agregar a la lista de acceso IP del proyecto. La entrada de la lista de acceso IP puede ser awsSecurityGroup, cidrBlock o ipAddress. No configure este parámetro si configura 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 alcance de esta entrada de la lista de acceso IP.

      La longitud máxima es 80.

    • eliminarDespuésDeFecha cadena(fecha-hora)

      Fecha y hora tras las cuales MongoDB Cloud elimina 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 posterior a una semana después de enviar esta solicitud. El recurso devuelve este parámetro si se especificó una fecha de vencimiento al crear esta entrada de la lista de acceso IP.

    • ID de 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 desea agregar a la lista de acceso IP del proyecto. Su entrada en la lista de acceso IP puede ser awsSecurityGroup, cidrBlock o ipAddress. No configure este parámetro si configura 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 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/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"
}