atlas api projectIpAccessList createAccessListEntry

Agrega una o más entradas de lista de acceso al proyecto especificado.

El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.

MongoDB Cloud sólo permite conexiones de clientes al clúster desde las entradas en la lista de acceso IP del proyecto. Escriba cada entrada como una sola dirección IP o como un bloque de direcciones IP notado en CIDR. Este recurso reemplaza el recurso lista blanca. MongoDB Cloud eliminó las listas blancas en julio de 2021. Actualice sus aplicaciones para usar este nuevo recurso. El endpoint /groups/{GROUP-ID}/accessList gestiona la lista de acceso IP a la base de datos. Este punto final es distinto del punto final orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist, que gestiona la lista de acceso para las organizaciones de MongoDB Cloud. Este endpoint no admite solicitudes concurrentes de tipo POST. Debes enviar múltiples solicitudes POST de forma sincrónica.

Este comando se autogenera y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-creategroupaccesslistentry.

Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.

Sintaxis

Sintaxis del comando

atlas api projectIpAccessList createAccessListEntry [options]

opciones

Nombre	Tipo	Requerido	Descripción
--envelope	envelope	false	Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.
--file	string	false	ruta a tu archivo de solicitud de API. Déjelo vacío para utilizar la entrada estándar en su lugar; debe proporcionar uno u otro, pero no ambos.
--groupId	string	true	string hexadecimal única de 24dígitos que identifica tu proyecto. Utiliza el punto final [/groups](#tag/Projects/operation/listProjects) 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.
-h, --help		false	ayuda para createAccessListEntry
--includeCount	totalCount	false	Indicador que señala si la respuesta retorna el número total de ítems (totalCount) en la respuesta.
--itemsPerPage	Int	false	Número de elementos que la respuesta retorna por página.
-o, --output	string	false	formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON".
--outputFile	string	false	archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)
--número de página	Int	false	Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
--bastante		false	Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
--versión	string	false	Versión de la API que se debe usar al llamar a los endpoints de la API de Atlas [opciones: "2023-01-01"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se establece por defecto en "2023-01-01".

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Ejemplos

Agrega múltiples entradas a la lista de acceso del proyecto especificado

Cree el archivo siguiente y guárdelo como payload.json

[
  {
    "cidrBlock": "192.168.1.0/24",
    "comment": "Internal network range"
  },
  {
    "cidrBlock": "10.0.0.0/16",
    "comment": "VPC network range"
  }
]

Después de crear payload.json, ejecuta el siguiente comando en el mismo directorio.

atlas api projectIpAccessList createAccessListEntry --version 2023-01-01 --groupId [your-project-id]