Devuelve los detalles de la interfaz de nodo privado AWS especificada para tu proyecto.
Para utilizar este comando, debes autenticarte con una cuenta de usuario, cuenta de servicio o una clave API con el rol de Lectura del proyecto.
Sintaxis
atlas privateEndpoints aws interfaces describe <interfaceEndpointId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Id. del punto final de la interfaz | string | true | Cadena única que identifica la interfaz del punto final privado de AWS en AWS. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--endpointServiceId | string | true | string alfanumérico único de 24 caracteres que identifica el endpoint privado en Atlas. |
-h, --help | false | ayuda para describir | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará del archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
ID STATUS ERROR <InterfaceEndpointId> <ConnectionStatus> <ErrorMessage>
Ejemplos
# Return the JSON-formatted details of the AWS private endpoint interface with the ID vpce-00713b5e644e830a3 in AWS for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: atlas privateEndpoints aws interfaces describe vpce-00713b5e644e830a3 --endpointServiceId 5f4fc14da2b47835a58c63a2