Crie um snapshot de backup para seu projeto e cluster.
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.
Você pode criar snapshots de backup sob demanda para camada do cluster do Atlas M10 e maiores.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto. O Atlas suporta este comando apenas para clusters M10+.
Sintaxe
atlas backups snapshots create <clusterName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
clusterName | string | true | Nome do Atlas cluster cujo snapshot você deseja restaurar. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--desc | string | true | Descrição do snapshot on-demand. |
-h, --help | false | ajuda para criar | |
-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. |
--retention | int | false | Número de dias em que o Atlas deve guardar o snapshot sob demanda. Deve ser pelo menos 1. Este valor é padronizado como 1. |
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 '<Id>' created.
Exemplos
# Create a backup snapshot for the cluster named myDemo that Atlas retains for 30 days: atlas backups snapshots create myDemo --desc "test" --retention 30