instâncias de streams do Atlas descrever
Descreva uma instância do Atlas Stream Processing para seu projeto.
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
Sintaxe do comando
atlas streams instances describe <name> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | true | Nome da instância do processador Atlas Streams. |
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 NAME CLOUD REGION <Id> <Name> <DataProcessRegion.CloudProvider> <DataProcessRegion.Region>
Exemplos
# Return an Atlas Stream Processing instance with a specific name: atlas streams instance describe myProcessor
# Return a JSON-formatted Atlas Stream Processing instance with a specific name: atlas streams instance describe myProcessor --output json