fluxos da API do atlas getStreamInstance

O suporte do Atlas CLI para executar comandos com o está em pré-visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: Retorna os detalhes de uma instância de fluxo dentro do projeto especificado .

Para usar esse recurso, a chave de API solicitante deve ter as funções de Acesso a dados do projeto, Proprietário do projeto ou Proprietário do processamento do fluxo de projetos. Este comando está invocando o endpoint com OperationID: 'getStreamInstance'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance

Sintaxe

Sintaxe do comando

atlas api streams getStreamInstance [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--groupId	string	true	string exclusiva de dígitos hexadecimais 24que identifica seu projeto
-h, --help		false	ajuda para getStreamInstance
--includeConnections		false	sinalizador para indicar se as informações de conexões devem ser incluídas na instância de fluxo
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	string	false	no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)
--tenantName	string	true	etiqueta legível por humanos que identifica a instância de fluxo a ser retornada
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-02-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-02a01".

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.

Voltar

getStreamConnection

getStreamProcessor