Baixa os registros operacionais do espaço de trabalho de Processamento de Streams do Atlas especificado ou do processador de streams.
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades 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 ponto de extremidade da API fornecido.
Por padrão, os registros cobrem períodos de 30 dias. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter as roles de acesso a dados do projeto, de proprietário do projeto ou de proprietário do processamento do fluxo de projetos. A API não suporta chamadas diretas com o esquema de resposta json. Você deve solicitar um esquema de resposta gzip utilizando um cabeçalho de aceitação do formato: "Aceitar: aplicação/vnd.atlas.2025-03-12+gzip".
Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/ operation-downloadgroupstreamoperationallogs.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api streams downloadOperationalLogs [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--endDate | int | false | Registro de data/hora que especifica o ponto de término para a faixa de mensagens de registro a serem baixadas. O MongoDB Cloud expressa esse registro de data/hora pelo número de segundos decorridos desde a UNIX epoch. |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
-h, --help | false | ajuda para downloadOperationalLogs | |
-o, --output | string | false | formato de API preferido, pode ser ["gzip"] Este valor padrão é "gzip". |
--outputFile | 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) |
--spName | string | false | Nome do processador de stream para o qual os registros serão baixados. Uma string vazia baixará os registros de todos os processadores de stream no espaço de trabalho. |
--startDate | int | false | Registro de data/hora que especifica o ponto de início para a faixa de mensagens de registro a serem baixadas. O MongoDB Cloud expressa esse registro de data/hora pelo número de segundos decorridos desde a UNIX epoch. |
--tenantName | string | true | Etiqueta que identifica o espaço de trabalho do fluxo. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2025-03-12"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2025-03a12". |
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
atlas api streams downloadOperationalLogs --version 2025-03-12 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]