Devuelve todos los nodos privados para las instancias de base de datos federadas y archivos en l铆nea en el proyecto especificado.
El subcomando atlas api se genera autom谩ticamente desde la API de administraci贸n de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administraci贸n tienen su propio ciclo de vida de lanzamiento, que puede consultar a trav茅s del enlace de documentaci贸n del punto final de la API.
Para usar este recurso, la Cuenta de servicio o clave de API que realiza la solicitud debe tener los roles Proyecto solo lectura o Administrador de Charts del Proyecto.
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/operation/operation-listgroupprivatenetworksettingendpointids.
Para obtener m谩s informaci贸n y ejemplos, consulta la documentaci贸n de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api dataFederation listPrivateEndpointIds [options]
opciones
Nombre | Tipo | Requerido | Descripci贸n |
|---|---|---|---|
--envelope | envelope | false | Indicador que indica si la aplicaci贸n envuelve la respuesta en un objeto JSON tipo sobre. 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 sobre. La aplicaci贸n a帽ade el par谩metro de estado al cuerpo de la respuesta. |
--groupId | string | true | Cadena 煤nica de d铆gitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexi贸n [/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 listPrivateEndpointIds | |
--includeCount | recuento total | false | Indicador que especifica si la respuesta devuelve el n煤mero total de elementos (totalCount). |
--itemsPerPage | Int | false | N煤mero de elementos que la respuesta retorna por p谩gina. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado 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. |
--bonito | 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 utilizar谩 al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versi贸n m谩s reciente o el valor de configuraci贸n api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripci贸n |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizar谩 en tu archivo de configuraci贸n. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api dataFederation listPrivateEndpointIds --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8