Descreve um endpoint PrivateLink que pode ser usado como uma conexão do Atlas Stream Processor.
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 qualquer uma das seguintes funções: Proprietário do projeto, Proprietário do processamento do fluxo do projeto.
Sintaxe
atlas streams privateLinks describe <connectionID> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ID de conexão | string | true | ID do ponto de extremidade PrivateLink. |
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. |
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.
ID PROVIDER REGION VENDOR STATE INTERFACE_ENDPOINT_ID SERVICE_ENDPOINT_ID DNS_DOMAIN DNS_SUBDOMAIN <Id> <Provider> <Region> <Vendor> <State> <InterfaceEndpointId> <ServiceEndpointId> <DnsDomain> <DnsSubDomain>
Exemplos
# describe a PrivateLink endpoint for Atlas Stream Processing: atlas streams privateLink describe 5e2211c17a3e5a48f5497de3