mongocli atlas privateendpoint describe
The privateendpoint describe command retrieves information about one
private endpoint connection for a given Atlas project.
Syntax
mongocli atlas privateendpoint(s)|privateEndpoint(s) describe <private-endpoint-id> [ --output|-o <output-format> ] [ --profile|-P <profile-name> ] [ --projectId <project-ID> ]
Note
Use -h or --help to view the command-line help for
this command.
Arguments
Argument | Type | Description | Required? |
|---|---|---|---|
<private-endpoint-id> | string | Unique identifier of the private endpoint connection that you
want to retrieve. | yes |
Options
Option | Type | Description | Required? |
|---|---|---|---|
--output, -o | string | Command output format. Valid values are:
If omitted, the command returns output in the default format. | no |
--profile, -P | string | Name of the profile where the public and private
keys for the project are saved. If omitted, uses the
default profile. To learn more about creating a
profile, see Configure the MongoDB CLI. | no |
--projectId | string | Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable. | no |
Output
If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.
ID ENDPOINT SERVICE STATUS ERROR <private-endpoint-id> <private-endpoint-service> <private-endpoint-status> <private-endpoint-error>
The default output is a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the Public API reference for your MongoDB service:
Example
The following command retrieves one private endpoint connection for a project using the default profile, which contains credentials and the project ID. The output is returned in the default format.
mongocli atlas privateendpoint describe 5f4fc81c1f03a835c2728ff7
The previous command prints the following to the terminal.
ID ENDPOINT SERVICE STATUS ERROR 5f4fc81c1f03a835c2728ff7 com.amazonaws.vpce.us-east-1.vpce-svc-06c32a54aec6cbb44 WAITING_FOR_USER
The following command retrieves one private endpoint connection for a project using the default profile, which contains credentials and the project ID. The output is returned in JSON format.
mongocli atlas privateendpoint describe 5f4fc81c1f03a835c2728ff7 --output json
The previous command prints the following to the terminal in JSON format.
{ "id": "5f4fc81c1f03a835c2728ff7", "endpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-06c32a54aec6cbb44", "status": "WAITING_FOR_USER" }