- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
experimental: Altera a data de validade de um snapshot de backup na nuvem para um cluster no projeto especificado, a chave de API solicitante deve ter a função de "gerenciador de backup do projeto".
Este comando está invocando o endpoint com OperationID: 'updateSnapshotRetention'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention
Sintaxe
atlas api cloudBackups updateSnapshotRetention [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | etiqueta legível por humanos que identifica o cluster |
--envelope | false | sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope | |
--file | string | false | caminho para o arquivo que contém o conteúdo da solicitação de API |
--groupId | string | true | string exclusiva de dígitos hexadecimais 24que identifica seu projeto |
-h, --help | false | ajuda para updateSnapshotRetention | |
--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 formato de impressão bonita | |
--snapshotId | string | true | string exclusiva de dígitos hexadecimais 24que 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". |
-w, --watch | false | Sinalizador que indica se o comando deve ser observado até que ele conclua a execução ou o aviso expire. | |
--watchTimeout | int | false | Tempo em segundos até que um relógio expire. Após o tempo limite de observação, a CLI não observa mais o comando. |
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. |