Baixe um snapshot para o cluster flexível especificado.
Visualização pública: o subcomando atlas api, 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.
Você pode baixar um snapshot para um cluster do Atlas Flex. Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role Proprietário do projeto. O Atlas suporta este comando apenas para clusters Flex.
Sintaxe
atlas backups snapshots download <snapshotId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
snapshotId | string | true | String única de 24dígitos hexadecimais que identifica o snapshot a ser baixado. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
-h, --help | false | ajuda para download | |
--out | string | false | Nome do arquivo de saída. Esse valor é padronizado para a ID do snapshot. |
--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.
Snapshot '<Name>' downloaded.