Retorne uma interface de endpoint privada GCP específica para o seu projeto.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Somente Leitura do projeto.
Sintaxe
atlas privateEndpoints gcp interfaces describe <id> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | true | Identificador exclusivo do endpoint privado que você deseja recuperar. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--endpointServiceId | string | true | String única alfanumérica de 24 caracteres que identifica o endpoint privado no Atlas. |
-h, --help | false | ajuda para descrever | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
ENDPOINT STATUS DELETE REQUESTED <EndpointGroupName> <Status> <DeleteRequested>
Exemplos
atlas privateEndpoints gcp interfaces describe endpoint-1 \ --endpointServiceId 61eaca605af86411903de1dd