Visualização pública: forneça comentários: retorna um snapshot de backup legado para um cluster no projeto especificado.
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 comentários em https://feedback.mongodb.com/forums/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.
Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto. A partir de 23 de março de 2020, todos os novos clusters podem usar apenas backups em nuvem. Quando você faz upgrade para 4.2, seu sistema de backup faz upgrade para o backup em nuvem, caso esteja atualmente definido como backup legado. Após fazer o upgrade, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tinha uma política de backup personalizada em vigor com backups legados, você deve recriá-la com o procedimento descrito na documentação de backups em nuvem.
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/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 | |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--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) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--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
atlas api legacyBackup getLegacySnapshot --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId]