Visualização pública: forneça comentários em: retorna um snapshot de backup legado para um cluster no projeto especificado.
Para usar esse recurso, a chave de API solicitante deve ter a função de "somente leitura" do projeto. A partir de 23 de março 2020, todos os novos clusters podem usar apenas backups na nuvem. Ao atualizar para 4.2, seu sistema de backup atualiza para o backup na nuvem se estiver atualmente definido como backup legado . Após esta atualização, todos os seus snapshots de backup legado existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com a sua política de retenção. Sua política de backup é redefinida para o cronograma padrão. Se você tiver uma política de backup personalizada em vigor com backups legado , deverá recriá-la com o procedimento descrito na documentação do Cloud Backup.
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api legacyBackup getLegacySnapshot [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Etiqueta legível por humanos que identifica o cluster. |
--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 getLegacySnapshot | |
--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) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>. | |
--snapshotId | string | true | String única de 24 dígitos hexadecimais que identifica o snapshot desejado. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-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-01a01". |
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
Execute o comando abaixo.
atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false --snapshotId [snapshotId]