Retorne os detalhes do endpoint privado da federação de dados especificado para o seu projeto.
Para usar esse comando, você deve se autenticar com uma conta de usuário, uma conta de serviço ou uma chave de API com a role Proprietário do projeto.
Sintaxe
atlas dataFederation privateEndpoints describe <endpointId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
endpointId | string | true | Identificador de endpoint do endpoint privado da Data Federation. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-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. |
Exemplos
# retrieves data federation private endpoint '507f1f77bcf86cd799439011': atlas dataFederation privateEndpoints describe 507f1f77bcf86cd799439011