atlas api dataFederation createPrivateEndpointId

Agrega un punto final privado para instancias federadas de base de datos y Archivos en línea a los Proyectos especificados.

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.

Si el ID del endpoint ya existe y el comentario asociado no ha cambiado, Atlas Data Federation no realiza ningún cambio en la lista de IDs del endpoint. Si el ID del endpoint ya existe y se cambia el comentario asociado, Atlas Data Federation actualiza el valor del comentario únicamente en la lista de ID de endpoint. Si el ID del punto final no existe, Atlas Data Federation agrega el nuevo punto final a la lista de puntos finales en la lista de ID del punto final. Cada región tiene un nombre de servicio asociado para los diferentes puntos finales. Para obtener la lista más reciente de las regiones admitidas y sus nombres de servicio, consulta la documentación externa.

Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operación/operation-creategroupprivatenetworksettingendpointid.

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 dataFederation createPrivateEndpointId [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 createPrivateEndpointId
-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)
--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.